QPR - Administrators Guide

QPR

Administrator's Guide

Version 8.1.1

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 errorsor omission of facts contained herein. QPR reserves the right to modify specifications cited in this documentwithout prior notice.

Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of thisdocument may be reproduced or transmitted in any form or by any means, electronic or manual, for anypurpose, without the express written permission of QPR Software Plc.

Copyright © QPR Software Plc. 2003 - 2010. All Rights Reserved.

QPR Administrator's Guide

Contents


Table of Contents

................................................................................................................................. 1 Introduction 1

................................................................................................................................. 2 System Architecture 2

............................................................................................................................. 32.1 Multiple QPR Systems on a Single Machine

.................................................................................................................................

3 System Requirements &Recommendations 4

............................................................................................................................. 43.1 Hardware Recommendations

............................................................................................................................. 53.2 Supported Databases

............................................................................................................................. 63.3 Supported Operating Systems

............................................................................................................................. 73.4 Supported Web Servers

............................................................................................................................................................ 10CGI/ISAPI Installation and Configuration

...................................................................................................................................................... 11Requirements

...................................................................................................................................................... 11Installation

...................................................................................................................................................... 11Configuration

............................................................................................................................. 113.5 Supported Web Browsers

............................................................................................................................. 123.6 Other Requirements

................................................................................................................................. 4 Installing QPR 8.1 15

............................................................................................................................. 154.1 Preparations

............................................................................................................................................................ 15Verify that You Have the Latest Version

............................................................................................................................................................ 15Pre-installation Checklist

...................................................................................................................................................... 15Resources and User Rights

...................................................................................................................................................... 15Install Databases

............................................................................................................................................... 16Set Up Microsoft SQL Server for QPR Products

............................................................................................................................................... 16Set Up Oracle for QPR Products

...................................................................................................................................................... 17Web Server

...................................................................................................................................................... 18User Directory

...................................................................................................................................................... 18Hardware

...................................................................................................................................................... 18Software

...................................................................................................................................................... 18What to Install?

............................................................................................................................. 194.2 Install

............................................................................................................................................................ 20QPR Suite Installation

............................................................................................................................................................ 22Designer Installation

............................................................................................................................................................ 24Custom

............................................................................................................................................................ 26Service Installation

............................................................................................................................................................ 27Configuration Suggestions

............................................................................................................................................................ 27System Validation Checklist

............................................................................................................................................................ 28Silent and Customized Installations

...................................................................................................................................................... 28Typical Silent Installation

...................................................................................................................................................... 29Customized Installation

............................................................................................................................................................ 30Installing QPR ProcessGuide with MSI Package

...................................................................................................................................................... 31Requirements

...................................................................................................................................................... 31Basic Installation

...................................................................................................................................................... 33Upgrade Installation

...................................................................................................................................................... 33Silent and Customized Installations

............................................................................................................................................... 33Typical Silent Installation

............................................................................................................................................... 34Customized Installation

Contents


............................................................................................................................................................ 35Installing QPR FactView

............................................................................................................................. 364.3 Migrating to QPR 8.1

............................................................................................................................................................ 37Importing QPR Portal Customizations to a New Version

............................................................................................................................. 414.4 Modify

............................................................................................................................. 414.5 Uninstallation

............................................................................................................................. 424.6 Troubleshooting

................................................................................................................................. 5 QPR Product Activation 43

............................................................................................................................. 455.1 Activating the Software

............................................................................................................................................................ 48Automatic Activation via Web

............................................................................................................................................................ 49Manual Activation via Web

............................................................................................................................................................ 50Manual Activation via Phone/Email

............................................................................................................................................................ 53Silent Product Activation

............................................................................................................................................................ 53Installation and QPR.ini

............................................................................................................................. 545.2 Evaluating the Software

............................................................................................................................. 545.3 QPR License Policy

............................................................................................................................................................ 55Transient Licenses

............................................................................................................................................................ 56Transient Product Activation

............................................................................................................................................................ 56License Types

............................................................................................................................................................ 58License Usage Report

................................................................................................................................. 6 Activation Procedure 59

.................................................................................................................................

7 Installing QPR ScoreCard IntegrationKit 60

................................................................................................................................. 8 Configuring QPR Installation 61

............................................................................................................................. 618.1 QPR Configuration Manager

............................................................................................................................................................ 61Common Settings

............................................................................................................................................................ 63Database Operations

............................................................................................................................................................ 63Server Locations

............................................................................................................................................................ 64Server Log Settings

............................................................................................................................................................ 65Service Operations

............................................................................................................................................................ 66System Migration

............................................................................................................................................................ 67Versions

............................................................................................................................................................ 67QPR User Management Server Settings

............................................................................................................................................................ 69LDAP Settings

............................................................................................................................................................ 71QPR ScoreCard Server Settings

............................................................................................................................................................ 72QPR ProcessGuide Server Settings

............................................................................................................................................................ 73QPR Web Application Server Settings

............................................................................................................................................................ 76QPR Portal Plugin Settings

............................................................................................................................................................ 77QPR ProcessGuide Plugin Settings

............................................................................................................................................................ 78QPR ScoreCard Plugin Settings

............................................................................................................................. 808.2 Web Server Configuration

............................................................................................................................................................ 80Automatic Installation of the Adobe SVG Viewer Plug-in

............................................................................................................................................................ 81Support for Multiple QPR Web Application Servers

............................................................................................................................................................ 81Error Message Customization

................................................................................................................................. 9 User Management & Security 82

............................................................................................................................. 829.1 Logging into the User Management System

............................................................................................................................. 829.2 User Rights for the User Management Client

............................................................................................................................. 829.3 Defining Users and Groups

............................................................................................................................. 839.4 NT & LDAP User & Group Import

Contents


............................................................................................................................. 839.5 Authentication Methods

............................................................................................................................................................ 83NT & LDAP Authentication

...................................................................................................................................................... 83With Synchronized NT/LDAP Group Management

...................................................................................................................................................... 84With "UMS only" Group Management

............................................................................................................................................................ 85Using Single Sign-On with QPR Products

............................................................................................................................. 889.6 LDAP Configuration Settings

............................................................................................................................................................ 88LDAP Configuration Settings in "qpr.ini" File

............................................................................................................................................................ 90Steps for Creating a New LDAP Setup

............................................................................................................................................................ 90Example of Configuring Connection to Windows Active Directory LDAP

............................................................................................................................................................ 91Example of Configuring Connection to Lotus Domino Directory

................................................................................................................................. 10 Web Publishing 93

............................................................................................................................. 9310.1 Dynamic Web Application Server

............................................................................................................................. 9310.2 Static Web Publishing

............................................................................................................................................................ 93Static Web Publishing with QPR ProcessGuide

............................................................................................................................................................ 93Static Web Publishing with QPR ScoreCard

................................................................................................................................. 11 Maintenance 94

............................................................................................................................. 9411.1 Modeling Phase Routines

............................................................................................................................................................ 94Daily Routines

............................................................................................................................................................ 94Weekly Routines

............................................................................................................................................................ 95Monthly Routines

............................................................................................................................. 9511.2 Steady Phase Routines

............................................................................................................................................................ 95Daily Routines

............................................................................................................................................................ 95Weekly Routines


............................................................................................................................................................ 95Quarterly Routines

............................................................................................................................. 9611.3 Startup Phase Routines

............................................................................................................................................................ 96Daily Routines

............................................................................................................................................................ 96Weekly Routines


............................................................................................................................. 9611.4 Notes & Limitations

............................................................................................................................. 9711.5 Troubleshooting

................................................................................................................................. 12 Appendices 100

............................................................................................................................. 10012.1 Appendix A: Common QPR ini-file (qpr.ini)

............................................................................................................................. 13712.2 Appendix B: Windows Registry Usage

............................................................................................................................. 13812.3 Appendix C: Running Multiple Versions Simultaneously

............................................................................................................................. 14012.4 Appendix D: QPRSettings.dat File

............................................................................................................................. 14112.5 Appendix E: Changing Web Server

............................................................................................................................. 14212.6 Appendix F: Audit Logs and User Audit Logs

............................................................................................................................................................ 142Audit Logs

...................................................................................................................................................... 142Audit Log for QPR ScoreCard

...................................................................................................................................................... 144Audit Log for QPR ProcessGuide

............................................................................................................................................................ 145User Audit Logs

...................................................................................................................................................... 145User Audit Log for QPR ScoreCard Server

...................................................................................................................................................... 146User Audit Log for QPR Web Application Server

...................................................................................................................................................... 148User Audit Log for QPR ProcessGuide Server

...................................................................................................................................................... 149User Audit Log for QPR User Management Server

............................................................................................................................. 15112.7 Appendix G: QPR Transfertool Command Line Parameters

................................................................................................................................. 13 References 156

Contents


................................................................................................................................. 14 Acknowledgements 157

Introduction

QPR Administrator's Guide 1

1 Introduction

QPR Server is the backbone of the QPR 8 software suite. The QPR Server is comprised of fiveindividual server components:

QPR User Management ServerQPR ScoreCard Application ServerQPR ProcessGuide Application ServerQPR Web Application ServerQPR Web Services Foundation (not installed by default)

This guide provides you with information on how to set up, configure and maintain the QPR Server.You can also find description of the common initialization file QPR.ini in Appendix A as well asinformation about the Windows Registry entries written by the QPR installation in Appendix B.

System Architecture


2 System Architecture

The following diagram illustrates how QPR products interoperate.

QPR System Architecture

QPR System Components

QPR ScoreCard Designer (Development Client in most of the product documentation)

QPR ScoreCard is the tool to be used primarily for the development of models and for QPR ScoreCardadministration; however, it can also be used for browsing models as well. The following functions canbe performed using QPR ScoreCard: model creation and development, data input, user administration,report management, and customizing graphics.

QPR ScoreCard Application Server

The QPR ScoreCard Application Server is used for handling model operations and user management.The application server provides ScoreCard content also to QPR Portal with the help of QPR WebApplication Server.

QPR ProcessGuide Designer (Development Client in most of the product documentation)

The QPR ProcessGuide Designer is used for model creation and development of models, modeladministration, and web publishing of models. In addition, it can be used for browsing models.

QPR ProcessGuide Application Server

System Architecture


The QPR ProcessGuide Application Server is used for handling model operations and usermanagement. The application server provides ProcessGuide content also to QPR Portal with the helpof QPR Web Application Server.

QPR Add-In for Microsoft Office

QPR Add-in for Microsoft Office is a seamlessly integrated add-in module for Microsoft Word 2007enabling pixel perfect reporting and creation of automatic publications.

QPR User Management System

The QPR User Management System (UMS) is a user authentication system that is used by QPRproducts. This system is for the authentication of users, whereas the administering of specific rights tothe users is performed separately with each QPR product. Users and groups can be managed from theQPR User Management Client. Therefore users and groups are not added with QPR ProcessGuide butwith the QPR User Management Client.

QPR Web Application Server

QPR Web Application Server (WAS) is the key component in dynamic web publishing of QPR products.Dynamic web contents of QPR products are displayed and modified with the help of three differentplugins (QPR Portal Plugin, QPR ProcessGuide Plugin, and QPR ScoreCard Plugin) running on the QPRWeb Application Server.

QPR Web Services Foundation

QPR Web Services Foundation is a web services based open interface to all QPR information. Itenables integration of third party systems and development of customized web applications utilizingQPR information.

QPR Portal (Web Client)

QPR Portal combines information from QPR Software products (QPR ScoreCard and QPRProcessGuide) into one portal view, which contains the relevant information customized for eachindividual user's needs. QPR Portal Plugin is a dynamic link library, which uses a set of HTMLtemplates in creating the content. In addition, a set of additional files such as graphics, css files, etc.,must be installed to the web server computer in order to present information correctly.

2.1 Multiple QPR Systems on a Single Machine

It is also possible to run many QPR Servers on the same computer. Having multiple instances of QPRServers installed is also possible. See the instructions for having multiple versions installedsimultaneously in Appendix C and follow them where applicable.

System Requirements & Recommendations


3 System Requirements & Recommendations

This chapter describes the requirements and recommendations for the different components of QPR8.1.

3.1 Hardware Recommendations

The following hardware / operating system configurations are recommended to be used with variousQPR 8.1 components. Note that these recommendations are based on a general case installation. Thesystem may in fact require more or less hardware depending on the usage of the system.

QPR ScoreCard and QPR ProcessGuide Designers

OS CPU Memory Network Speed Disk Space

Windows XP Intel Pentium 4equivalent or faster

1 GB At least a 256 kbpsconnection to theserver. 1 MB or fasterrecommended.

300 MB free disk

Windows Vista -"- 2 GB -"- -"-

Windows 7 -"- 2 GB -"- -"-

QPR ScoreCard and QPR ProcessGuide Web Clients

CPU Memory Network Speed

Intel Pentium 4equivalent or faster

1 GB 256 kbps minimum. 1 MB or fasterrecommended.

QPR Servers

System Size OS CPU Memory DiskSpace

OtherRequirements

Small QPRImplementation

Windows2003 or 2008Server (x86)

2 x Intel XEON 2GHz(dual core) equivalentor faster

4 GB 20 GB Gigabit TCP/IPNetwork, Graphicscard capable of 32-bit colors &Database runningon a separatesystem

Note: These recommendations are for an implementation of a system with approximately 5 Designerusers and 50 QPR Portal users.


OtherRequirements

Large QPRImplementation

Windows2003 or 2008Server (x64)

2 x Intel XEON 2GHz(quad core) equivalentor faster

12 GB 100 GB Gigabit TCP/IPNetwork, Graphicscard capable of 32-bit colors &




OtherRequirements

Database runningon a separatesystem

Note: These recommendations are for an implementation of a system with approximately 20Designer users and 1000 QPR Portal users. QPR servers are always running in 32-bit mode.

3.2 Supported Databases

The following databases are supported by the QPR applications:

1. Generic Database Requirements

MDAC version 2.7 or laterSupport for the following data types:

Oracle: NUMBER, NVARCHAR2, RAW, NCLOB, BLOB, DATESQL Server: INT, FLOAT, NVARCHAR, NTEXT, VARBINARY, IMAGE, DATETIME Access: INT, FLOAT, VARCHAR, TEXT, MEMO, VARBINARY, IMAGE, DATETIME

Support for Unicode character set.

2. Version and Driver Requirements

Note that only Windows versions of multi-platform databases are supported. However, non-Windowsversions may also work, but the functionality cannot be guaranteed and you must verify thefunctionality by yourself in such cases.

Your database must meet both the generic database requirements and the DBMS/editionrequirements listed below. Database compatibility can be tested with the QPR Configuration Managerand it should be done every time a new database is taken into use.

Make sure that the database is using a Unicode character set.

Only Windows versions of the databases listed below have been verified and are officially supportedby 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 alternativeoperating systems.

Note that only 32-bit ODBC drivers are supported with all supported databases.

DatabaseManagement System

Edition Architecture Platform Additional Notes

Microsoft Access 2003 32-bit (x86) MicrosoftWindows

For standalone useonly.

Microsoft Access 2007 32-bit (x86) MicrosoftWindows

For standalone useonly.

Microsoft SQL Server2005

ExpressWorkgroupStandardEnterprise

32-bit (x86)64-bit (x64)

MicrosoftWindows

Microsoft SQL Server Express 32-bit (x86) Microsoft



DatabaseManagement System

Edition Architecture Platform Additional Notes

2008 WorkgroupStandardWebDeveloperEnterprise

64-bit (x64) Windows

Oracle Database 10g Express EditionPersonal EditionStandard EditionOneStandard EditionEnterprise Edition

32-bit (x86)64-bit (x64)

MicrosoftWindows

Verify platform-specificinstallation, supporteddrivers, supportedpatch sets, andsupported clients withQPR Customer Care

Oracle Database 11g Personal EditionStandard EditionOneStandard EditionEnterprise Edition

32-bit (x86)64-bit (x64)

MicrosoftWindows

Verify platform-specificinstallation, supporteddrivers, supportedpatch sets, andsupported clients withQPR Customer Care

Note about Oracle character sets: The national character set in Oracle must always beAL16UTF16, and the database character set must be AL32UTF8.

3.3 Supported Operating Systems

The following operating systems are supported by the different QPR components:

OperatingSystem

Edition Application Server /WAS

DevClient

Standalone

WebClient

32-bit 64-bit*

Windows 7 Any (seenotes afterthe list)

X X X X X X

Windows 2008 Server X X - X X X

Windows Vista Any (seenotes afterthe list)

X X X X X X

Windows 2003 Server X X - X X X

Windows 2003 Server R2 X X - X X X

Windows XP Professional X X X X X X

Mac OS X 10.2.x orlater

- - - X

Note: Default web servers shipped with non-server versions of Windows may impose limits on theamount of concurrent users. E.g. Microsoft Windows XP Professional automatically imposes a 10-connection limit on IIS. You cannot change this limit. Please verify the limits from the operatingsystem documentation.

Note: Some Windows XP's special features such as fast user switching are not supported.



Note: In Windows XP Service Pack 2 and Service Pack 3 the built-in firewall is enabled by default andmay prevent you from connecting to QPR Portal with the default settings. In the case this happens,please configure the firewall to allow traffic between the QPR Portal computer and client computers.

*Note: Even though QPR components can be run on a 64-bit environment, they are run in 32-bitmode. Therefore, they are subject to 32-bit limitations, as regards, for example memory allocation.

Windows Vista edition compatibility:Home Basic edition does not support running QPR Web Application ServerHome Premium edition does not support Windows Integrated AuthenticationBusiness, Enterprise, and Ultimate editions support all features available in QPR 8.1

Windows 7 edition compatibility:Home Basic edition does not support running QPR Web Application ServerHome Premium edition does not support Windows Integrated AuthenticationProfessional, Enterprise, and Ultimate editions support all features available in QPR 8.1

3.4 Supported Web Servers

QPR Software certifies the following web servers:

Web Server Version

Apache 2.2.x

Microsoft Internet InformationServices

6.0 - 7.5 (only qpr.dll issupported on IIS 7.0 &7.5)

With other servers the functionality must be separately tested or separately confirmed by QPR. Notethat QPR Web Services Foundation is supported only on Microsoft Internet Information Services.

Common Microsoft Internet Information Services Configuration

In order for QPR Portal and QPR Web Services Foundation to work properly, handlers for the CGIbinary/ISAPI DLL and the .svc extension need to be able to use both GET and POST methods (verbs).

Things to Note with Microsoft Internet Information Services 6.0

There are two things you need to do if you are running the Microsoft Internet Information Services6.0 (included in Windows 2003) web server software:

Create a virtual directory for the CGI binary or ISAPI DLLAllow CGI or ISAPI extensions

To perform the abovementioned tasks, follow the instructions below:

How to make a new virtual directory1. Go to Start Menu -> Programs -> Administrative Tools -> Internet Information Services (IIS)

Manager.2. Expand the Server name and the Web Sites section3. Right-click the Default Web Site option and select New -> Virtual Directory from the pop-up



menu4. The Virtual Directory Creation Wizard appears. In the first page, type an alias for the virtual

directory (for example Scripts for QPR Portal) and click Next.5. In the second page, click the Browse button and locate the CGI binary / ISAPI DLL

installation folder. Click Next.6. In the third page, select the following rights from the list: Read, Run scripts, and Execute.

Make sure that the other check boxes are unchecked. Click Finish to complete the wizard.

How to allow CGI/ISAPI Extensions1. Go to Start Menu -> Programs -> Administrative Tools -> Internet Information Services (IIS)

Manager.2. Expand the Server name and the Web Service Extensions sections3. Select All Unknown CGI Extensions (in the case you use qpr.exe) or All Unknown ISAPI

Extensions (in the case you use qpr.dll) from the list in the right side of the window.4. Click the Allow button.

In order for SVG views to work properly, you need to verify that there is a MIME type mapping forSVG images and add it if necessary. To add the mapping, do the following:

1. Go to Start Menu -> Control Panel -> Administrative Tools -> Internet Information Services (IIS)Manager.

2. Right-click the Default Web Site directory and click Properties.3. Click the HTTP Headers tab.4. Click MIME Types.5. If .svg is not listed, select New and input .svg as the extension and image/svg+xml as the MIME

type.6. Click OK and restart the website

In order for Silverlight to work properly, you need to verify that there are the necessary MIME typemappings for file types used by Silverlight and add them if necessary. To add the mappings, do thefollowing:


2. Right-click the Default Web Site directory and click Properties.3. Click the HTTP Headers tab.4. Click MIME Types.5. If .xaml is not listed, select New and input .xaml as the extension and application/xaml+xml as

the MIME type.6. Similarly, add the following types if they are missing:

Extension: .xap, MIME type application/x-silverlight-appExtension: .xbap, MIME type application/x-ms-xbap

7. Click OK and restart the website

Additional configuration in 64-bit editionIn order to run qpr.dll you must configure IIS 6.0 to run 32-bit applications on a 64-bit Windows. Todo this, follow the instructions below:1. Open a command prompt and navigate to the <System root drive>\Inetpub\AdminScripts

directory.2. Type the following command: cscript.exe adsutil.vbs set W3SVC/AppPools/

Enable32BitAppOnWin64 “true”3. Press Enter

If you want to use qpr.exe, you don’t have to set the IIS 6.0 to run 32-bit applications.



For more information see: http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/13f991a5-45eb-496c-8618-2179c3753bb0.mspx?mfr=true

Using QPR Portal with Internet Information Services 7.0 / 7.5

The following things need to be done if you are using QPR Portal with Microsoft Internet InformationServices (IIS) 7.0 in Windows Vista and Windows Server 2008 or IIS 7.5 in Windows 7.

IIS SetupIn addition to the default selections, the following extra modules need to be installed for IIS 7.0 / 7.5:

World Wide Web Services -> Application Development Features -> .NET Extensibility (for QPR WebServices Foundation)World Wide Web Services -> Application Development Features -> ASP.NET (for QPR Web ServicesFoundation)World Wide Web Services -> Application Development Features -> ISAPI ExtensionsWorld Wide Web Services -> Application Development Features -> ISAPI FiltersWeb 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 onWindows Server 2008:

Application Development -> ASP.NET (for QPR Web Services Foundation)Application Development -> .NET Extensibility (for QPR Web Services Foundation)Application Development -> ISAPI ExtensionsApplication Development -> ISAPI Filters

When using Windows 7, add also the following feature to IIS 7.5:Microsoft .NET Framework 3.5.1 -> Windows Communication Foundation HTTP Activation

On Windows Vista and Windows 7 these selections can be made in the "Turn Windows features on oroff" section in the Control Panel. On Windows Server 2008 the selection is available at Server Manager-> Roles -> Web Server (IIS) -> Add Role Services.

If you intend to use QPR Web Services Foundation, you may need to perform some additionalconfiguration depending on whether IIS was installed by the time the .NET Framework 3.5 wasinstalled (note that the framework is installed during the QPR 8 installation if you select either theQPR Web Services Foundation or the QPR Add-In for Microsoft Office 2007 to be installed).

If IIS was installed at the time the .NET Framework 3.5 was installed, all necessary associationsshould already be configured properlyIf IIS was installed when .NET Framework 3.5 was already present on the machine, you need toregister .svc and .aspx extensions by running the following command:

o "%WINDIR%\Microsoft.Net\Framework\v3.0\Windows Communication

Foundation\ServiceModelReg.exe" -r

o Alternatively follow the instructions at http://msdn.microsoft.com/en-us/library/ms752252.aspx

o In Windows 7 .NET Framework 3.5 is installed by default, just make sure that the necessary

features are enabled prior to QPR installation (see above)

Do the following to allow qpr.dll (for QPR Portal) to be executed:


2. Expand the Server name and open the ISAPI and CGI Restrictions section.3. Select Add.4. Browse the path to the QPR.dll (using qpr.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.dll) into the ISAPI or

http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/13f991a5-45eb-496c-8618-2179c3753bb0.mspx?mfr=true

http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/13f991a5-45eb-496c-8618-2179c3753bb0.mspx?mfr=true

http://msdn.microsoft.com/en-us/library/ms752252.aspx



CGI Path field.5. Input a description for the extension and check the "Allow extension path to execute"

checkbox.6. Click the OK button.

In order for SVG views to work properly, you need to verify that there is a MIME type mapping forSVG images and add it if necessary. To add the mapping, do the following:


2. Select Default Web Site.3. Open the MIME Types section.4. If .svg is not listed, select Add and input .svg as the extension and image/svg+xml as the MIME

type.5. Click OK and restart the website

In order for Silverlight to work properly, you need to verify that there are the necessary MIME typemappings for file types used by Silverlight and add them if necessary. To add the mappings, do thefollowing:


2. Select Default Web Site.3. Open the MIME Types section.4. If .xaml is not listed, select Add and input .xaml as the extension and application/xaml+xml as

the MIME type.5. Similarly, add the following types if they are missing:

Extension: .xap, MIME type application/x-silverlight-appExtension: .xbap, MIME type application/x-ms-xbap

6. Click OK and restart the website

Additional configuration in 64-bit editionIn order to run qpr.dll you must enable 32-bit applications in IIS 7.0 / 7.5. The settings are done inthe same way as in 32-bit environment (see System Requirements.pdf for normal settings). Inaddition, verify that “Enable 32-Bit Application” is set to TRUE in the application pool you are using(the QPR application pool does this automatically).

3.4.1 CGI/ISAPI Installation and Configuration

There are two alternative ways of utilizing web publishing.CGI binary application for Windows platforms. This works with all supported web servers except forIIS 7 and IIS 7.5. ISAPI DLL for Windows platforms and Microsoft Internet Information Services (IIS). This is arecommended choice if you are running IIS as the ISAPI DLL performs faster than the CGI binary.



3.4.1.1 Requirements

The following is needed:Web server software, certified either by QPR Software or tested by customer.Adequate computer and operating system for server usage (support for multitasking etc.). CGI-binary executable runs only in Windows.Using the ISAPI DLL requires Microsoft IIS.TCP/IP connection to computer that runs the QPR Web Application Server.

3.4.1.2 Installation

Web server software is installed according to software-specific installation instructions.CGI binary application and the ISAPI DLL are installed with the QPR Web Application Serverinstallation.

Note that plugin-specific contents must be separately installed to web server computer, if plugins usedrequire files there.

3.4.1.3 Configuration

CGI-binary and web server configuration include the following settings:The following URLs must be mapped according to the web server-specific instructions:

URL for web contents needed by QPR Portal.URL for CGI-binary used by QPR Web Application Server.

QPR Web Application Server connection settings are given during CGI-binary installation. Thesettings are:

Host IP is the TCP/IP address of the computer where QPR WAS is installed (127.0.0.1 refersto the local computer). Host Port is the socket port number used by WAS, default value is the same as in WASinstallation.

The settings are saved in qprsettings.dat file.

3.5 Supported Web Browsers

The following web browsers are compatible with QPR Portal:

Web Browser Version

Microsoft Internet Explorer 6.0, 7.0, 8.0

Mozilla Firefox for Windows 3.0, 3.5

Mozilla Firefox for Linux and Mac OS X 3.0, 3.5

Note: Using Mini Portal in Microsoft Internet Explorer 6 is not recommended due to performanceissues and the limited support of CSS 2.1 in Microsoft Internet Explorer 6.

Note: Mini Portal is not supported with Right-to-Left Languages.



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: The built-in SVG viewer in Mozilla Firefox does not work properly with QPR Portal. The built-inSVG viewer can be disabled and the Adobe viewer installed in the following way:1. Go to about:config (type it into the address bar)2. Search for svg.enabled setting and change it to false3. Copy NPSVG3.dll and NPSVG3.zip from <Program Files>\Common Files\Adobe\SVG Viewer 3.0 to

<Program Files>\Mozilla Firefox\plugins. Check the supported version from the listing in OtherRequirements section.

4. Restart Mozilla Firefox

Browser Configuration

Usually default settings are correct, i.e. no separate configuration is needed. However the followingsettings may need attention:

Browser must allow execution of JavaScript and JavaScript must be allowed to perform thefollowing functions:

Open new windowsResize and move windows

In some cases, a pop-up blocker may interfere with QPR Portal. It is advisable to add QPRPortal as a whitelisted (allowed) site which can open windows freely in the case a whitelistingpossibility exists.Depending on contents browsed through QPR Portal, it may be advisable to set the 'Emptypage history' setting on.

The URL for logging into QPR Portal is:

http://<host name>/<script_path>/qpr.exe

Substitute qpr.exe with qpr.dll in the case the server is using the ISAPI DLL, or with qpr.cgi in thecase you are using a web server running on some other platform than Windows.

Browser Security Settings

In the case you have problems with logging into the QPR Portal, verify that your browser's securitysettings are set so that QPR Portal can be used. With Microsoft Internet Explorer the security settingscan be defined in the Security tab under the Internet Options menu, which can be found in the Toolsmenu.

3.6 Other Requirements

See the requirements for different miscellaneous or optional components below:

SVG Requirements

QPR 8.1 supports the Adobe SVG Viewer versions 3.01 - 3.03. See the table below for notes aboutbrowser compatibility:

Browser Supported Versions

Microsoft Internet Explorer 3.03




Mozilla Firefox 3.01

Note: You can use Microsoft Silverlight (see requirements below) instead of Adobe SVG.

Silverlight Requirements

QPR 8.1 supports the Microsoft Silverlight version 3.0. See the table below for notes about browsercompatibility:


Microsoft Internet Explorer 6 3.0



Note: You can use Adobe SVG (see requirements above) instead of Microsoft Silverlight.

.NET Requirements

Microsoft .NET Framework 3.5 is required for using QPR Web Services Foundation and QPR Add-In forMicrosoft Office 2007. If you select either of the features to be installed and you do not have theframework installed, it is installed during the QPR 8 installation. However, the .NET Frameworkinstallation requires an Internet connection, so without a connection you need to acquire theframework by other means. If you wish to install the framework before installing QPR 8, you canacquire it from http://www.microsoft.com/downloads/details.aspx?FamilyID=333325FD-AE52-4E35-B531-508D977D32A6&displaylang=en.

Microsoft .NET Framework 2.0 or later is required for using QPR ScoreCard Designer and QPR WebApplication Server. QPR 8 installation will install Microsoft .NET Framework 2.0 SP2 if it is not presenton the computer and QPR ScoreCard Designer and/or QPR Web Application Server is selected to beinstalled.

Office Requirements

Using the QPR Add-In for Microsoft Office 2007 requires Microsoft Word 2007 and Visual Studio Toolsfor Office runtime 3.0 SP1. The VSTO runtime as well as Office 2007 Primary InteroperabilityAssemblies are installed during the QPR Add-In for Microsoft Office 2007 installation in the case theyare 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

http://www.microsoft.com/downloads/details.aspx?FamilyID=333325FD-AE52-4E35-B531-508D977D32A6&displaylang=en

http://www.microsoft.com/downloads/details.aspx?FamilyID=333325FD-AE52-4E35-B531-508D977D32A6&displaylang=en



If LDAP (Lightweight Directory Access Protocol) is used for authentication, the followingimplementations are supported:

Windows Active DirectoryOpenLDAP 2.3

Hard Drive Requirements

In order for the installation to succeed, the hard drive should have at least 300 megabytes of freespace.

Integration Kit Requirements

Using the QPR ScoreCard Integration Kit requires that Microsoft SQL Server is used. See more detailsabout the supported versions in the Supported Databases chapter.

Localization Requirements

In multilingual environments you may need to install additional fonts to computers running QPRProcessGuide Designer and/or QPR ScoreCard Designer. On Windows Vista and newer systems thenecessary fonts are usually installed by default, but on Windows XP you may need to install additionalfonts. 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 theadditional language support files.

The system requirements provided herein do not extend to situations where a defect or an error hasbeen recognized in a third party vendor software product listed herein as a supported product. Sucherrors are e.g. all errors that the third party vendor has acknowledged by releasing a service pack or anew version addressing the issue, or errors which are in some other way publicly acknowledged bythe vendor.

Installing QPR 8.1


4 Installing QPR 8.1

Most QPR products are installed with one single installation package, which allows an easy andstraightforward installation.

The installation requires that Windows Installer 3.1 (all supported versions of Windows prior toWindows Vista) is installed. Every later version of Windows has a required Windows Installer versioninstalled out of the box. In the case you do not have the Windows Installer engine installed or youhave an older version, please acquire a supported version from Windows Update. In addition, MDAC2.7 or newer is required for the installation.

Some preparations need to be done before starting the actual installation. See the Preparationschapter for information about the required pre-installation tasks.

4.1 Preparations

Good preparations are the most important factor in carrying out a successful installation. Please readthrough this section carefully to ensure that your system environment is ready for QPR 8 installation.

4.1.1 Verify that You Have the Latest Version

To be able to follow these instructions precisely, verify that you have the latest version of QPR 8.1.See http://usernet.qpr.com for information about the latest version.

4.1.2 Pre-installation Checklist

4.1.2.1 Resources and User Rights

In order to perform the QPR 8 installation you need to have administrative privileges in Windows. Alsomake sure that you have an adequate amount of free hard disk space. See the System Requirementssection for information about the required amount.

4.1.2.2 Install Databases

QPR products use DataBase Management Systems (DBMS) for administrating users and storing userand model data.

The primary requirement for the database server is that it needs to be an SQL DBMS with an OpenDataBase Connectivity (ODBC) interface. You can use any DBMS which conforms to theserequirements, but the installation will be the most convenient when one of the directly supportedDBMSes is used.

When you have decided upon the database server, install and configure the DBMS. For installationinstructions, please select the instructions according to your DBMS:

http://usernet.qpr.com

Installing QPR 8.1


Set Up Microsoft SQL ServerSet Up Oracle

4.1.2.2.1 Set Up Microsoft SQL Server for QPR Products

Here are the instructions for setting up a Microsoft SQL Server DBMS for QPR products:

Install Microsoft SQL Server.

For Microsoft SQL Server installation instructions, see the MS SQL Server manual.

Create and configure a database for QPR products.

All QPR products use a single database instance, so you need to create and configure only onedatabase for the whole system.

Please consult your Microsoft SQL Server 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 wellas the transaction log. They both should have space for at least 100 MB of data. With largeramounts of data the allocations and database settings most probably need to be adjusted.

You can test your database configuration by clicking the Test Database Configurationbutton 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 8.1 installation folder.

Verify also that there is an ODBC data source configured for the database and configure it ifneeded. In 64-bit Windows environments, the data sources configured with the ODBC DataSource Administrator available in the Control Panel cannot be seen in QPR ConfigurationManager. To be visible, the data source must be configured with "odbcad32.exe", which can befound in C:\WINDOWS\SysWOW64.

Continuing with the Installation

Database installation is complete. However, before taking the database into use, you need to createthe product-specific contents to it by using the QPR Configuration Manager utility. The databasecontents are created with the Create new database option in the Database Operations tab of theCommon section. Note that you need to install the software before you can access the configurationutility, so you will have to create the QPR contents later during the installation procedure.

4.1.2.2.2 Set Up Oracle for QPR Products

Here are the instructions for setting up an Oracle DBMS for QPR products:

Install Oracle.

For Oracle installation instructions, see the Oracle manual.

Installing QPR 8.1


Create and configure a database for QPR products.

All QPR products use a single database instance, so you need to create and configure only onedatabase for the whole system.

Please consult your 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 wellas the transaction log. They both should have space for at least 100 MB of data. With largeramounts of data the allocations and database settings most probably need to be adjusted.

You can test your database configuration by clicking the Test Database Configurationbutton 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 8.1 installation folder.

Verify also that there is an ODBC data source configured for the database and configure it ifneeded. In 64-bit Windows environments, the data sources configured with the ODBC DataSource Administrator available in the Control Panel cannot be seen in QPR ConfigurationManager. To be visible, the data source must be configured with "odbcad32.exe", which can befound in C:\WINDOWS\SysWOW64.

Continuing with the Installation

Database installation is complete. However, before taking the database into use, you need to createthe product-specific contents to it by using the QPR Configuration Manager utility. The databasecontents are created with the Create new database option in the Database Operations tab of theCommon section. Note that you need to install the software before you can access the configurationutility, so you will have to create the QPR contents later during the installation procedure.

4.1.2.3 Web Server

In order to use QPR Portal, you need to have a web server software configured before installing QPR8.1. See the System Requirements chapter for information about supported web servers and consultthe server's installation instructions for information about its installation.

Web Server Configuration in Standalone Installation

If the QPR package is the only software needing a web server on your computer and you areinstalling a standalone version of the QPR package, you may consider restricting access to that server.For information about configuring the Microsoft IIS web server software, see http://www.microsoft.com/. If you are running the Apache web server, see http://httpd.apache.org/. There is also a tutorialabout configuring the .htaccess file for Apache at http://sniptools.com/.

http://www.microsoft.com/technet/treeview/default.asp?url=/technet/tcevents/itevents/iis/tnt1-40.asp

http://www.microsoft.com/technet/treeview/default.asp?url=/technet/tcevents/itevents/iis/tnt1-40.asp

http://httpd.apache.org/docs/howto/auth.html

http://sniptools.com/vault/windows-apache-and-htaccess-authentication.htm#quickwindows

Installing QPR 8.1


4.1.2.4 User Directory

QPR 8 utilizes QPR User Management System for user rights administration. QPR User ManagementSystem supports also user imports from NT domain and LDAP servers as well as Integrated WindowsAuthentication (IWA). Before making the installation it is advisable to plan how user rights for QPRproducts are managed and acquire required rights to e.g. active directory servers.

4.1.2.5 Hardware

Check the System Requirements chapter and verify that your hardware is adequate for running QPR8.

4.1.2.6 Software

If you intend to install QPR Web Services Foundation and/or QPR Add-In for Microsoft Office 2007(both available as options in the Custom setup, not included in a Typical installation), there are someadditional dependencies:

Microsoft .NET Framework 3.5 SP1 runtime for both featuresVisual Studio Tools for Office (VSTO) 3.0 SP1 runtime and Office 2007 Primary InteroperabilityAssemblies for QPR Add-In for Microsoft Office 2007

All of these requirements are included in the QPR 8 installation package and installed if thecorresponding features are selected to be included in the installation, but you might consider installingthese components before the QPR 8 installation in the following cases:

Bandwidth usage is a concern or you are installing the suite on multiple workstations. Due to thesize of the full runtime, the QPR 8 package includes only an installer bootstrapper which fetches therest of the framework from the Microsoft web site. Distributing the framework internally within yourorganization before QPR 8 installation eliminates the need for separately fetching the framework toall target workstations.You want to reduce time required to install QPR 8You want to install QPR 8 silently (VSTO runtime installation does not run silently when launchedfrom the QPR 8 package).

Note that in order for the QPR Add-In for Microsoft Office 2007 to work properly, the Office 2007installation needs to have the Visual Basic for Applications feature installed (found in the Office SharedFeatures section of the installation options).

4.1.2.7 What to Install?

There are three different setup types available in the QPR 8.1 package:

QPR Suite (Typical Installation). This option installs all components of QPR 8.1. QPR WebServices Foundation and QPR Add-In for Microsoft Office (available only if Microsoft Word 2007 isdetected on the computer) can be added to the installation but they are not included by default. Inthe Additional Tasks dialog you can define whether the installation should work in a standalonemode.

Installing QPR 8.1


QPR ProcessGuide and QPR ScoreCard Designers: With this option you can install QPRProcessGuide Designer and/or QPR ScoreCard Designer and optionally also QPR Add-In forMicrosoft Office. No server components are included in this setup type.Custom (for advanced users only). With this option you can customize the component selectionfreely.

The following options are available for the custom installation:

QPR 8.1 - ClientsQPR User Management ClientQPR ScoreCard DesignerQPR ProcessGuide DesignerQPR Add-In for Microsoft Office (not selected by default, available only if an Office 2007installation is detected on the computer)

QPR 8.1 - Servers

o QPR ScoreCard Application Server

o QPR ProcessGuide Application Server

o QPR User Management Server

o QPR Web Application Server

QPR Portal ScriptsQPR Portal Web Contents

o QPR Web Services Foundation (not selected by default). QPR Web Services Foundation is

supported only with Microsoft Internet Information Services.

You can choose any combination of the components listed above. Proceed with the instructions in thefollowing chapter depending on whether you selected the typical or the custom installation.

Microsoft .NET Framework 3.5 SP1 is required for installing QPR Web Services Foundation and theQPR Add-In for Microsoft Office 2007. In addition to the .NET Framework, the QPR Add-In forMicrosoft Office 2007 requires the VSTO 3.0 runtime to be installed. These additional requirementsare installed to your computer if you select the installation options that require them. The additionalinstallations take place after the "Ready to Install" step right before copying the QPR 8.1 files. Notethat the Typical installation option excludes the QPR Add-In for Microsoft Office 2007 and QPR WebServices Foundation, so you need to use the Custom setup in order to include them. Also note thatQPR Web Services Foundation is supported only on Microsoft Internet Information Services.

Microsoft .NET Framework 2.0 or later is required for installing QPR ScoreCard Designer and QPR WebApplication Server. QPR 8 installation will install Microsoft .NET Framework 2.0 SP2 if it is not presenton the computer and QPR ScoreCard Designer and/or QPR Web Application Server is selected to beinstalled.

QPR FactView is not part of the standard QPR installation package but it is installed separately. Forinstructions on installing QPR FactView, see Installing QPR FactView.

4.2 Install

Select the installation instructions based on what you are going to install:

Install the typical QPR suite or evaluate the software: Go to QPR Suite Installation InstructionsInstall only Designer components and/or QPR Add-in for Microsoft Office: Go to DesignerInstallation InstructionsFreely define the selection of components: Go to Custom Installation Instructions

Installing QPR 8.1


4.2.1 QPR Suite Installation

Follow the instructions below to install the QPR 8.1 Suite:

1. Choose Setup Language

Start the installation by selecting the language for the installation wizard from the drop-down list.Note that the software itself may have more languages available (see the packing slip or readme formore details) than what are offered for the installation wizard here.

2. Welcome Page

This is the starting point of the QPR 8.1 installation wizard. Click Next to continue.

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 inthe license agreement" and click Next to continue in the case you accept the license terms.Otherwise you'll need to cancel the installation.

4. Choose Setup Type

Here you can choose between three installation options, QPR Suite (Typical Installation), QPRProcessGuide and QPR ScoreCard Designers, and Custom. The QPR Suite option installs allcomponents except for QPR Web Services Foundation and the QPR Add-in for Microsoft Office (bothof which can be added as optional components in the next page). In the QPR ProcessGuide and QPRScoreCard Designers option one or both of the Designer clients and also optionally QPR Add-in forMicrosoft Office. With the Custon installation you can freely customize the selection of components. For these instructions, select QPR Suite (Typical Installation) and click Next to continue.

5. Select Optional Components

In this page you can choose to include also QPR Web Services Foundation and QPR Add-in forMicrosoft Office to the installation. Both of these additions require Microsoft .NET Framework 3.5 SP1,which will be installed in the case it is not present on the machine. QPR Add-in for Microsoft Office isavailable only if Microsoft Word 2007 is detected on the computer. Choose whether to include theseadditions in the installation and click Next to continue.

NOTE! The .NET Framework will be downloaded during the installation, so do not include theseoptions if you don't have the framework already installed and you don't have a network connection

6. Choose Destination Folder

Define the folder which will be the installation root folder for the QPR 8.1 package. All the componentswill be installed under this folder. By default the folder is C:\Program Files\QPR 8.1. You can alsochoose whether to install the product for all users or only for yourself. However, in the case you aregoing to install the server components as a service, install the product for all users.

Installing QPR 8.1


7. Choose Script Folder

*This step is skipped if you are using Microsoft Internet Information Services.

Here you need to define the location of your web server's CGI binary/script directory. This folder willcontain the CGI binary and script as well as ISAPI DLL files required by QPR Portal. With Apache thedefault script folder is cgi-bin under the Apache installation folder, and it is recommended that youcreate a version-specific sub-folder such as qpr81 under it.

After defining the script folder, click Next.

8. Choose Web Content Folder

Here you need to define the location of your web server's web contents directory. If you haveMicrosoft Internet Information Services installed, the folder will be detected automatically and theweb contents will be placed in a qpr81 sub-folder under that folder. With Apache the default scriptfolder is htdocs under the Apache installation folder, and it is recommended that you create a version-specific sub-folder such as qpr81 under it.

After defining the folder, click Next.

9. Select Additional Tasks

In this dialog you can choose additional features that will be installed. The options available are:

Create desktop icons. Creates icons to QPR ProcessGuide Designer Client, QPR ScoreCardDesigner, and QPR Portal (only in the case the Standalone installation option is selected as well)to your desktop. This option is selected by default on desktop versions of Windows.Standalone installation. Selecting this option configures the software so that also servers arestarted when a client (QPR ProcessGuide or QPR ScoreCard) is launched. This option is selectedby default on desktop versions of Windows. When this option is selected, the "Install QPR 8.1 asa service" option is not available and vice versa.Install QPR 8.1 as a service. This option is mainly for server installations, and makes theserver components to be run as a Windows Service. In the case you select this option, you canchoose whether the server is started during Windows startup. This option is selected by defaulton server versions of Windows. See Service Installation for more information.Copy all product documentation to the installation directory. In the case you areinstalling from a CD or from e.g. a network drive folder with all the QPR CD contents, you areasked whether you want to copy also the Documentation folder containing all the productdocumentation to your hard drive. On the other hand, if the installation is done from a plainQPR8Setup.exe, this option is not displayed.

10. Ready to Install

The installer is now ready to start copying the application files to the computer. If you need to changeany settings, click Back and make the necessary changes.

Once you are satisfied with the settings, click Install to start the installation.

11. Configuration

Before the end of the installation, QPR Configuration Manager appears so that you can verify your

Installing QPR 8.1


settings. However, in the case you had the Standalone option selected, the QPR ConfigurationManager is not displayed.

12. Complete

The installation is now complete. Check the "Activate the software now" checkbox if you wish tolaunch the QPR Product Activation Wizard after clicking Finish. Similarly, checking the "Show thereadme file" checkbox opens the readme file after you click Finish. In addition, if a QPR 7.6 or a QPR8.0 installation was found on the computer, there is also a "Launch the Migration Utility" optionavailable on the last page. Selecting that will open QPR Configuration Manager into the SystemMigration section after clicking Finish. If you have multiple options selected, the correspondingoperations are performed one at a time, i.e. the readme file is displayed after finishing the activationand the migration utility is not launched before the readme file is closed.

4.2.2 Designer Installation

Follow the instructions below to install QPR ProcessGuide Designer and/or QPR ScoreCard Designerand optionally also QPR Add-In for Microsoft Office:



2. Welcome Page





Here you can choose between three installation options, QPR Suite (Typical Installation), QPRProcessGuide and QPR ScoreCard Designers, and Custom. The QPR Suite option installs allcomponents except for QPR Web Services Foundation and the QPR Add-in for Microsoft Office (bothof which can be added as optional components in the next page). In the QPR ProcessGuide and QPRScoreCard Designers option one or both of the Designer clients and also optionally QPR Add-in forMicrosoft Office. With the Custon installation you can freely customize the selection of components. For these instructions, select QPR ProcessGuide and QPR ScoreCard Designers and click Nextto continue.

Installing QPR 8.1


5. Select Client Components to Install

In this page you can choose which client components are included in the installation. QPRProcessGuide Designer and QPR ScoreCard Designer are selected by default, but you can omit eitherone based on which licenses you have bought. You can also select to add QPR Add-In for MicrosoftOffice to the installation (this option is disabled if Microsoft Word 2007 is not installed on thecomputer). At least one of the options needs to be selected in order to continue. Select thecomponents you need and click Next to continue.

NOTE! The .NET Framework will be downloaded during the installation, so do not include QPR Add-Infor Microsoft Office options if you don't have the framework already installed and you don't have anetwork connection.





Create desktop icons. Creates icons for QPR ProcessGuide Designer and QPR ScoreCardDesigner to your desktop in the case those products were selected to be installed.Copy all product documentation to the installation directory. In the case you areinstalling from a CD or from e.g. a network drive folder with all the QPR CD contents, you areasked whether you want to copy also the Documentation folder containing all the productdocumentation to your hard drive. On the other hand, if the installation is done from a plainQPR8Setup.exe, this option is not displayed.

8. Ready to Install



9. Complete

The installation is now complete. Check the "Activate the software now" checkbox if you wish tolaunch the QPR Product Activation Wizard after clicking Finish. Similarly, checking the "Show thereadme file" checkbox opens the readme file after you click Finish.

Installing QPR 8.1


4.2.3 Custom

Follow the instructions below to install a custom QPR 8.1 installation:



2. Welcome Page





Here you can choose between three installation options, QPR Suite (Typical Installation), QPRProcessGuide and QPR ScoreCard Designers, and Custom. The QPR Suite option installs allcomponents except for QPR Web Services Foundation and the QPR Add-in for Microsoft Office (bothof which can be added as optional components in the next page). In the QPR ProcessGuide and QPRScoreCard Designers option one or both of the Designer clients and also optionally QPR Add-in forMicrosoft Office. With the Custon installation you can freely customize the selection of components. For these instructions, select Custom and click Next to continue.

5. Select Features

Select the features that will be installed. You can also change the destination folders here for variouscomponents. However, all features except for QPR Portal Scripts and QPR Portal Web Contents usethe same destination folder, so changing the destination folder for one of the features affects theothers as well. It is advisable to leave the QPR Portal Scripts and QPR Portal Web Contentsdestination folders to their default values in this dialog, as their locations will be determined in theforthcoming dialogs.

Once you have the desired set of features selected, click Next to continue.



Installing QPR 8.1


7. Choose Script Folder

*This step is skipped if you are using Microsoft Internet Information Services.

Here you need to define the location of your web server's CGI binary/script directory. This folder willcontain the CGI binary and script as well as ISAPI DLL files required by QPR Portal. With Apache thedefault script folder is cgi-bin under the Apache installation folder, and it is recommended that youcreate a version-specific sub-folder such as qpr81 under it.

After defining the script folder, click Next.

8. Choose Web Content Folder

Here you need to define the location of your web server's web contents directory. If you haveMicrosoft Internet Information Services installed, the folder will be detected automatically and theweb contents will be placed in a qpr81 sub-folder under that folder. With Apache the default scriptfolder is htdocs under the Apache installation folder, and it is recommended that you create a version-specific sub-folder such as qpr81 under it.

After defining the folder, click Next.



Create desktop icons. Creates icons to QPR ProcessGuide Designer, QPR ScoreCard Designer,and QPR Portal (only in the case the Standalone installation option is selected as well) to yourdesktop. This option is selected by default on desktop versions of Windows.Standalone installation. Selecting this option configures the software so that also servers arestarted when a client (QPR ProcessGuide or QPR ScoreCard) is launched. This option is selectedby default on desktop versions of Windows. When this option is selected, the "Install QPR 8.1 asa service" option is not available and vice versa.Install QPR 8.1 as a service. This option is mainly for server installations, and makes theserver components to be run as a Windows Service. In the case you select this option, you canchoose whether the server is started during Windows startup. This option is selected by defaulton server versions of Windows. See Service Installation for more information.Copy all product documentation to the installation directory. In the case you areinstalling from a CD or from e.g. a network drive folder with all the QPR CD contents, you areasked whether you want to copy also the Documentation folder containing all the productdocumentation to your hard drive. On the other hand, if the installation is done from a plainQPR8Setup.exe, this option is not displayed.

10. Ready to Install


Once you are satisfied with the settings, click Install to start the installation. If you selected QPRWeb Services Foundation and/or QPR Add-In for Microsoft Office 2007 to be installed, you may needto install some dependencies at this point. Follow the instructions on the screen to go through theinstallers for the dependencies. Restart your computer after the dependency installations if requestedso. In that case the QPR 8.1 installation is resumed after the restart.

Installing QPR 8.1


11. Configuration

Before the end of the installation, QPR Configuration Manager appears so that you can verify yoursettings. However, in the case you had the Standalone option selected, the QPR ConfigurationManager is not displayed.

12. Complete

The installation is now complete. Check the "Activate the software now" checkbox if you wish tolaunch the QPR Product Activation Wizard after clicking Finish. Similarly, checking the "Show thereadme file" checkbox opens the readme file after you click Finish. In addition, if a QPR 7.6 or a QPR8.0 installation was found on the computer, there is also a "Launch the Migration Utility" optionavailable on the last page. Selecting that will open QPR Configuration Manager into the SystemMigration section after clicking Finish. If you have multiple options selected, the correspondingoperations are performed one at a time, i.e. the readme file is displayed after finishing the activationand the migration utility is not launched before the readme file is closed.

For information about further customization possibilities, see the Silent and Customized Installationssection.

4.2.4 Service Installation

QPR Server components (i.e. both Application Servers, the QPR User Management System, and theQPR Web Application Server) can be installed as service on Windows XP, Windows 2003, WindowsVista, and Windows Server 2008. In the case you are installing one of more QPR server componentsand you have selected service to be installed, the QPR Service installation will be performed after thefiles are installed. The QPR Service controls all QPR 8.1 server components installed on the computer.

In the case you selected service to be installed during the installation, you are only asked whether youwant the service to be started during Windows start-up. If you need more configuration optionsregarding 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 formore information.

Service Installation Using Command Line Parameters

Service can be installed and uninstalled with command line parameters as well. With the commandline installation option you can install the service later on even if you have decided not to install itduring the QPR 8.1 installation. The installation/uninstallation is done by launching the QPR.Init.exe inthe Utilities folder under the QPR 8.1 installation folder followed by a parameter. The parameters are:

-i for installing the service. For example, launching 'qprinit.exe -i' in the Utilities folder startsservice installation for the QPR Service 8.1.-d for uninstalling the service. For example, launching 'qprinit.exe -d' in the Utilities folderuninstalls the QPR Service 8.1.

Installing QPR 8.1


4.2.5 Configuration Suggestions

This section provides information on suggested configuration for selected scenarios where the defaultconfiguration is not optimal.

Right-to-left LanguagesWhen running QPR Portal in right-to-left languages such as Arabic, the following configuration shouldbe done:

Use Microsoft Silverlight instead of Adobe SVGEnable the "Use bitmap text in graphical views" setting in the QPR Web Application Server -> QPRScoreCard Plugin section.

4.2.6 System Validation Checklist

Use the checklists below (pick the one that is applicable) to verify that your QPR system is properlyinstalled and configured on a basic level. Note that the checklists below are for reference purposesand they do not take into account any environment-specific settings.

Use this list if you selected the standalone option.

# Task Expected Output Notes

1 Start QPR ProcessGuideDesigner

The application is startedsuccessfully.

Also QPR User ManagementServer and QPR ProcessGuideServer are started

2 Open a server model in QPRProcessGuide

Model is opened without errors.

3 Start QPR ScoreCardDesigner


Also QPR ScoreCard Server isstarted

4 Open a model in QPRScoreCard


5 Start QPR Web ApplicationServer

QPR Web Application Server isstarted successfully.

6 Launch QPR Portal Login is successful.

7 Browse QPR ProcessGuideand QPR ScoreCard Modelsin Portal

All models are displayedsuccessfully.

You may need to install an SVGplugin or Microsoft Silverlight firstin order to view some QPRScoreCard views.

8 Access http://localhost/QPR81WebServices/servicetester.aspx and clickQueryObjectsAsXml

The tester is launchedsuccessfully and clicking onQueryObjectsAsXml returns aresult set with multiple objects

* Applicable only if you installedQPR Web Services Foundation.

9 Launch Microsoft Word 2007 The QPR tab appears in Word. * Applicable only if you installedQPR Add-In for Microsoft Office.

http://localhost/QPR81WebServices/servicetester.aspx



Installing QPR 8.1


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,start the service. Otherwisestart all QPR servers (QPRUser Management Server,QPR ScoreCard Server, QPRProcessGuide Server, andQPR Web Application Server)

The service is startedsuccessfully or all servercomponents are startedsuccessfully.

2 Open a server model in QPRProcessGuide


3 Start QPR ScoreCardDesigner


4 Open a model in QPRScoreCard


5 Launch QPR Portal Login is successful.

6 Browse QPR ProcessGuideand QPR ScoreCard Modelsin Portal

All models are displayedsuccessfully.

You may need to install an SVGplugin or Microsoft Silverlight firstin order to view some QPRScoreCard views.

7 Access http://<hostname>/QPR81WebServices/servicetester.aspx and clickQueryObjectsAsXml

The tester is launchedsuccessfully and clicking onQueryObjectsAsXml returns aresult set with multiple objects

* Applicable only if you installedQPR Web Services Foundation.

8 Launch Microsoft Word 2007 The QPR tab appears in Word. * Applicable only if you installedQPR Add-In for Microsoft Office.

4.2.7 Silent and Customized Installations

Follow the instructions in the following sections to install QPR 8.1 silently or to customize aninstallation with the graphical user interface included.

4.2.7.1 Typical Silent Installation

To perform a silent installation equivalent to the typical installation with the default settings, open thecommand prompt to the folder containing the QPR8Setup.exe package and start the installation withthe following command: QPR8Setup.exe /s /v"/qn ALLUSERS=1 FASTOEM=1"

Once the desktop icons have appeared on the desktop and the msiexec process is not running (seethe Task Manager) anymore, you can start using the software.

See the next section for information about how to customize e.g. the selection of softwarecomponents included in the installation.

Installing QPR 8.1


4.2.7.2 Customized Installation

To customize the silent installation, you can supply some of the public properties listed below tocustomize the behavior of the silent installation. The base command required in all cases is QPR8Setup.exe /s /v"/qn followed by a selection of properties listed below. Remember also toadd a closing double quote after defining the properties you want. In addition, make sure that thereare no spaces in the /v"/qn part to ensure correct functionality. Note that you can also supply theproperties to an normal (i.e. not silent) installation. In that case, omit the /s and /qn options from thebase command. In addition, if any properties require values that need to be enclosed in doublequotes, you need to escape those double quotes with a preceding backslash to avoid prematurelyterminating the string supplied to the /v option. Example: QPR8Setup.exe /s /v"/qn INSTALLDIR=\"C:\Program Files\QPR 8.1\""

Note that you can define settings such as server connection strings by having them included in a pre-configured qpr.ini file in the same folder as the QPR8Setup.exe package. In the case such a file exists,it is copied to the installation folder during the installation and the settings included in it are usedwhen the actual settings file created into C:\ProgramData\QPR Software\QPR 8\8.1\Settings inWindows Vista and later versions and <path to All Users profile>\Application Data\QPR Software\QPR8\8.1\Settings in earlier versions of Windows. However, the file may not get copied properly in thecase the installation package is located in a network drive.

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 theinstallation. Note that only one PRODUCTACTIVATION option can be selected for an installation, sothis property cannot coexist with PRODUCTACTIVATION=2 or PRODUCTACTIVATION=3.PRODUCTACTIVATION=2: Activates a 14-day evaluation license (if allowed) silently at the endof the installation.PRODUCTACTIVATION=3: Performs a silent activation at the end of the installation providedthat there's a properly filled qpr.ini present in the folder containing the QPR8Setup.exe package.See details about the necessary settings below.NOIISCONFIG=1: Skips the automatic creation of Microsoft IIS virtual directories. This is useful inthe case you are using some other web server software and you are having problems with theinstallation.NOSERVICE=1: Skips the QPR Service installation. The service is installed by default on servereditions of Windows, so you can use this option in the case you want to install the service manuallyafter a silent installation on for instance Windows Server 2003/2008.ASKSCRIPTFOLDER=1: Requests for the script/CGI-binary folder also when Microsoft IIS isfound on the computer. This can be used also in non-silent installation to provide additional control.

Example 1: Install QPR 8.1 silently and activate an evaluation license: QPR8Setup.exe /s /v"/qnPRODUCTACTIVATION=2"

In the case you want to customize the selection of features installed within a silent installationsimilarly as you could do in the Select Features dialog in the Custom installation, you can do so bylowering the installation level below the default (100) and adding the desired features using theADDLOCAL property. Feature names:

PGDevelopmentClient: QPR ProcessGuide DesignerSCDevelopmentClient: QPR ScoreCard DesignerUserManagementClient: QPR User Management ClientQPRAddInForOffice2007: QPR Add-In for Microsoft Office 2007. Requires Microsoft .NET Framework3.5 SP1, VSTO runtime 3.0 SP1 and Office 2007 Primary Operability Assemblies. All of theseprerequisites are installed during the QPR 8.1 installation if QPR Add-In for Microsoft Office 2007 isselected to be installed and the prerequisites are not installed.SCApplicationServer: QPR ScoreCard ServerPGApplicationServer: QPR ProcessGuide ServerUserManagementServer: QPR User Management Server

Installing QPR 8.1


WASAndPlugins: QPR Web Application Server.WASScripts: QPR Web Application Server Scripts (CGI scripts and binaries and ISAPI DLL)WASWebContents: QPR Web Application Server Web ContentsWASWebServices: QPR Web Services Foundation. Requires Microsoft .NET Framework 3.5 SP1,which is installed during the QPR 8.1 installation if QPR Web Services Foundation is selected to beinstalled and the framework cannot be found on the computer.PGDesktopIcon: Desktop icon for QPR ProcessGuideSCDesktopIcon: Desktop icon for QPR ScoreCardPortalDesktopIcon: Desktop icon for QPR PortalWLTShortcut: Start menu shortcut for QPR Product ActivationConfigShortcut: Start menu shortcut for QPR Configuration Manager

To define installation location for these, provide values to the INSTALLDIR (all features except forWASScripts and WASWebcontents), CGI (WASScripts), and WASWEB (WASWebContents) properties.Note that with web servers other than Microsoft IIS you need to define a value for WASWEB if youdefine a value for CGI and vice versa. For Microsoft IIS the value is set to be "Scripts" under thefolder defined by WASWEB unless also ASKSCRIPTFOLDER=1 is provided.

Example 2: Install QPR 8.1 silently with only QPR ScoreCard Designer (including the Desktop icon) aswell as QPR Web Application Server and necessary scripts and web contents to defined locations andlaunch the product activation at the end of the installation: QPR8Setup.exe /s /v"/qnINSTALLLEVEL=10 ADDLOCAL=SCDevelopmentClient,SCDesktopIcon,WASAndPlugins,WASWebContents,WASScripts INSTALLDIR=\"C:\Program Files\QPR 8 Custom\"WASWEB=\"C:\inetpub\wwwroot\qpr81\" PRODUCTACTIVATION=2"

Requirements for silent activation

In order to use the PRODUCTACTIVATION=3 property succesfully, the following settings need to bepresent in the qpr.ini file located in the same folder with the QPR8Setup.exe package. Substitute anypossible whitespaces with a plus sign +.

[WLT Modes]UseSilentForTransient=1UseSilentForFirstActivation=1

[WLT Customer Info]CustomerCode=<valid product activation code>Email=<valid e-mail>FirstName=<name>LastName=<name>Country=<country>Organization=<organization>

4.2.8 Installing QPR ProcessGuide with MSI Package

This section guides you through installing the standalone MSI package of QPR ProcessGuide. Theinstallation requires that you have at least version 2.0 of the Windows Installer engine (which can beobtained through Windows Update).

Note that you should not install this package if you're using other components of the QPR 8.1 suite. In

Installing QPR 8.1


those cases, please install QPR ProcessGuide with the QPR 8.1 installer.

4.2.8.1 Requirements

See the System Requirements & Recommendations section. Requirements for QPR ProcessGuideDesigner apply here.

4.2.8.2 Basic Installation

Follow the instructions below to install a basic installation of QPR ProcessGuide 8.1:

1. Welcome Page

This is the starting point of the QPRProcessGuide 8.1 installation. Click Next tocontinue.


Here you can see the End User Software Licenseterms for the software that is about to beinstalled. You will need to accept these termsbefore continuing the installation. Select "I acceptthe terms in the license agreement" and click Next to continue in the case you accept thelicense terms. Otherwise you'll need to cancel theinstallation.

Installing QPR 8.1


4. Customer Information

Here you need to define the customerinformation and select whether the application isinstalled for all users or only for yourself.Technically this setting controls whether the Startmenu and desktop shortcuts are copied to thecommon profile or to your personal profile.

Click Next to continue.

5. Select Destination Folder

Define the folder where QPR ProcessGuide 8.1will be installed. By default the folder is C:\Program Files\QPR ProcessGuide.

Click Next to continue.

6. Ready to Install

The installer is now ready to start copying theapplication files to the computer. If you need tochange any settings, click Back and make thenecessary changes.


Installing QPR 8.1


7. Installation Complete

The installation is now complete, and you canstart using QPR ProcessGuide.

4.2.8.3 Upgrade Installation

Follow the instructions below to upgrade your existing QPR ProcessGuide MSI 8.1 installation:

1. Welcome Page: This page informs you about the existing version that is detected. Click Next tocontinue.

2. License Agreement: Here you can see the End User Software License terms for the software thatis 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.

3. Customer Information: Here you need to define the customer information and select whetherthe application is installed for all users or only for yourself. Technically this setting controls whetherthe Start menu and desktop shortcuts are copied to the common profile or to your personal profile.

4. Select Destination Folder: Here you can see where the installation that is to be updated islocated. In case the installer can successfully locate the existing installation, controls for changingthe path are disabled.

5. Ready to Install: The installer is now ready to start copying the new application files to thecomputer. The old version is removed during this phase. Click Next to start the upgrade.

6. Installation Complete: The upgrade is now complete, and you can start using QPR ProcessGuideXpress. Note that you need to reactivate the product after an upgrade.

4.2.8.4 Silent and Customized Installations

Follow the instructions in the following sections to install QPR ProcessGuide silently or to customize aninstallation with the graphical user interface included.

4.2.8.4.1 Typical Silent Installation

To perform a silent installation equivalent to the basic installation, open the command prompt to thefolder containing the QPR ProcessGuide.msi package and start the installation with the followingcommand: msiexec /i "QPR ProcessGuide.msi" /qn ALLUSERS=1

Once the QPR ProcessGuide icon has appeared on the desktop and the msiexec process is not running(see the Task Manager) anymore, you can start using the software.

Installing QPR 8.1


4.2.8.4.2 Customized Installation

To customize the silent installation, you can supply some of the public properties listed below tocustomize the behavior of the silent installation. The base command required in all cases is msiexec /i "QPR ProcessGuide.msi" /qn followed by a selection of properties listed below. Notethat you can also supply the properties to an normal (i.e. not silent) installation. In that case, omit the/qn option from the base command.

Note that you can define the server connection string also by having it included in a pre-configuredqpr.ini file in the same folder as the QPR ProcessGuide.msi package. In the case such a file exists, it iscopied to the settings folder during the installation. The settings folder is located under C:\ProgramData\QPR Software\QPR 8\8.1\Settings in Windows Vista and later versions and <path to AllUsers profile>\Application Data\QPR Software\QPR 8\8.1\Settings in earlier versions of Windows. Alsonote that the file may not get copied properly in the case the installation package is located in anetwork drive.

Properties:PRODUCTACTIVATION=1: Launches the QPR Product Activation Wizard at the end of theinstallation. Note that only one PRODUCTACTIVATION option can be selected for an installation, sothis property cannot coexist with PRODUCTACTIVATION=2 or PRODUCTACTIVATION=3.PRODUCTACTIVATION=2: Activates a 14-day evaluation license (if allowed) silently at the endof the installation.PRODUCTACTIVATION=3: Performs a silent installation at the end of the installation providedthat there's a properly filled qpr.ini present in the folder containing the QPR ProcessGuide.msipackage. See details about the necessary settings below.PGSERVERNAME="<name with which the server connection appears in the menu>": Inthis property you can supply the name of the QPR ProcessGuide Server to which an automaticconnection is established when the client (QPR ProcessGuide) is started. Using this propertyrequires that also PGSERVERLOCATION property is supplied. In the case PGSERVERNAME andPGSERVERLOCATION are not provided, the client will work in a file model mode and a serverconnection is not established automatically.PGSERVERLOCATION="<IP address or a host name>": In this property you can supply thelocation of the QPR ProcessGuide server. The location can be either an IP address or a host name.Using this property requires that also PGSERVERNAME property is supplied.PGSERVERPORT="<port number>": If the QPR ProcessGuide Server is using some other portthan the default one, you can supply it in this property. Using this property requires that bothPGSERVERNAME and PGSERVERLOCATION properties are supplied, but in the case this is left out,the server connection is defined to use the default port.

Example 1: Install QPR ProcessGuide silently and activate an evaluation license: msiexec /i "QPRProcessGuide.msi" /qn PRODUCTACTIVATION=2

Example 2: Install QPR ProcessGuide from a graphical user interface, but configure it to connect toyour company's server using the default port and launch the product activation at the end of theinstallation: msiexec /i "QPR ProcessGuide.msi" /qn PGSERVERNAME="Company X PG"PGSERVERLOCATION="pg.company.com" PRODUCTACTIVATION=1

Requirements for silent activation

In order to use the PRODUCTACTIVATION=3 property succesfully, the following settings need to bepresent in the qpr.ini file located in the same folder with the QPR ProcessGuide.msi package:

[WLT Modes]UseSilentForTransient=1UseSilentForFirstActivation=1

Installing QPR 8.1


[WLT Customer Info]CustomerCode=<valid customer code>Email=<valid e-mail>FirstName=<name>LastName=<name>Country=<country>

4.2.9 Installing QPR FactView

QPR FactView is not part of the standard QPR installation package. QPR FactView Server installationcan be performed off CD media or from a disk file. To install QPR FactView Server, insert the CD in adrive accessible from the target server hardware.

Note: Install QPR FactView Portal Interface after first installing QPR Portal.

Note: QPR FactView Portal Interface requires that Microsoft Internet Information Services (IIS) isused as the web server.

Note: If the required Microsoft .NET 2.0 Framework is not installed, it will be included as part of theQPR FactView Server installation process.

Install QPR FactView Server

1. Insert the QPR FactView installation CD into the drive, and in the case autorun is disabled, runQPRFVLauncher.exe manually from the root of the CD.

2. Select the QPR FactView Server option in the launcher. The QPR FactView Server installationprogram is now started.

3. In the Welcome screen, click Next to continue the setup.4. Select the region for the local location of the server and click Next.5. Read the license agreement, and continue by selecting I accept the license agreement, and

then click Next.6. Enter the user information and click Next.7. All files will be installed under the specified folder location. Define the installation location and

uncheck the Install typical components option. Continue to feature selection by clicking Next.8. In order to use QPR Portal integration, remove QvWebServer from the list of features to be

installed. Continue by clicking Next.9. Define the account for running the service and click Next.10. Click Next to install the application.11. Once the installation is complete, click Finish.

Install QPR FactView Portal Interface

1. Insert the QPR FactView installation CD into the drive, and in the case autorun is disabled, runQPRFVLauncher.exe manually from the root of the CD.

2. Select the QPR Portal Interface option in the launcher. The QPR FactView Portal Interfaceinstallation program is now started.

3. In the Welcome screen, click Next to continue the setup.4. Read the license agreement, and continue by selecting I accept the terms in the license

agreement, and then click Next.5. Select the installation folder and click Next to continue.6. Click Install to install the application.

Installing QPR 8.1


7. Once the installation is complete, click Finish.

Enable QPR FactView in QPR Portal

To launch QPR FactView via QPR Portal, launch QPR Configuration Manager and select the "Enablelink to QPR FactView" option in the QPR Web Application Server -> General section. With this option,an additional tab called Analytics is available in QPR Portal.

Activate the license for QPR FactView

For activating QPR FactView you need a valid license key. To obtain the key and to activate QPRFactView, contact QPR Customer Care.

4.3 Migrating to QPR 8.1

While the QPR 8.1 installation does recognize a QPR 7.6 or a QPR 8.0 installation, an upgrade similarto older QPR versions is not offered or performed. Instead of upgrading the QPR 7.6/8.0 installation,QPR 8.1 is installed side-by-side with QPR 7.6/8.0 with default folders changed so that with thedefault settings QPR 7.6/8.0 installation is not overwritten (provided that also QPR 7.6/8.0 wasinstalled to default folders). If QPR 7.6/8.0 is detected on the computer, there is a possibility tolaunch the migration utility at the end of the QPR 8.1 installation. With the help of the migration utilityyou can transfer your old settings and database from QPR 7.6/8.0 easily. For more information forperforming the migration, see the System Migration section in QPR - Configuration Instructionsdocument.

Some issues to note:The default communication ports are the same in both versions, so when installing QPR 8.1 side-by-side with QPR 7.6/8.0, you either need to run only one version at a time or change the ports theother version is usingOnly one version can be registered for QPR scripting at a time. You may need to manually registerthe desired version by running QPR.PG.Client.exe /regserver or QPR.SC.Client.exe /regserver (notethat the exe names were proguide.exe and scclient.exe respectively on versions up to the initialrelease of QPR 8.0) in the corresponding installation directories.While the full migration including the settings is available only from QPR 7.6/8.0, you can transferalso QPR 7.5 databases with the database transfer functionality. Other settings need to betransferred manually. See the table below for reference.Customizations to QPR Portal templates do not get transferred automatically by the migrationutility. See the next chapter for more information about transferring the Portal customizations.Tick marks in gauges included in QPR ScoreCard graphs now display the values according to thedisplay settings defined for the measurement unit. In QPR 8.0 and earlier the values were roundedto the nearest half or full number. This may have a severe display impact on elements which useunits that display more than two digits after the decimal point.The possibility to control the tabs sections in the processes' Detail View in QPR Portal (previouslydone in the 'Select Properties and Custom Attributes' dialog in QPR ProcessGuide) has beenremoved from the user interface in QPR 8.1. The visibility can now be controlled by editing the webtemplates.Settings for QPR Portal default views are stored in qpr.ini, so also settings should be migrated (orthe relevant ini file sections copied manually) in addition to a database transfer.Check in all checked out QPR ProcessGuide models before migrating the database.

Summary of automatic migration possibilities

Transferred from 7.6 & 8.0 Transferred from 7.5

Database X X

Installing QPR 8.1


Settings (ini files) X -

Portal customizations - -

4.3.1 Importing QPR Portal Customizations to a New Version

The custom stylesheet structure of the QPR package makes it easier to import old Portalcustomizations to the new version when upgrading the QPR suite. For instructions concerning thecustomization 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 tocopy 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 anycustomized images in use. Do not overwrite the existing custom.css file as there can be some newstyles 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 7.5 and QPR 7.6/8.0,so you may need to modify some templates if you have referenced files located in earlier web contentdirectories. See below for details about the changes. In addition, templates from an earlier version areunlikely to work as such in a newer version, so when upgrading for example from QPR 7.6 to QPR 8.1,the old templates folder should not be dropped into the new installation as such, but thecustomizations should be ported instead. Porting means that the differences between the original QPR7.6 templates and new QPR 8.1 templates are analyzed and customizations ported where applicableor necessary.

QPR WAS and Portal Templates

See the tables below for information about where QPR Portal templates are located in differentversions so that you can properly port any customizations you might have in your templates.

Briefing Booklet templates

Version Folder location

7.5 <QPR 7 installation root>\Web ApplicationServer\Templates\Booklet

7.6 <path to All Users profile>\Application Data\QPR Software\QPR 7\7.6\Templates\WAS\Booklet

Note: Templates are initially installed to <QPR 7 installationroot>\Web Application Server\Templates\Booklet, but they arecopied to the path indicated above during the first startup and usedfrom the All Users profile (ProgramData folder in Vista and laterversions) location, so all customizations should be made to thosetemplates.



Installing QPR 8.1





Common templates


7.5 <QPR 7 installation root>\Web ApplicationServer\Templates\Common

7.6 <path to All Users profile>\Application Data\QPR Software\QPR 7\7.6\Templates\WAS\Common

Note: Templates are initially installed to <QPR 7 installationroot>\Web Application Server\Templates\Common, but they arecopied to the path indicated above during the first startup and usedfrom the All Users profile (ProgramData folder in Vista and laterversions) location, so all customizations should be made to thosetemplates.





Portal templates


7.5 <QPR 7 installation root>\Web Application Server\Templates\Portal

7.6 <path to All Users profile>\Application Data\QPR Software\QPR 7\7.6\Templates\WAS\Portal

Note: Templates are initially installed to <QPR 7 installationroot>\Web Application Server\Templates\Portal, but they are copiedto the path indicated above during the first startup and used fromthe All Users profile (ProgramData folder in Vista and later versions)

Installing QPR 8.1



location, so all customizations should be made to those templates.


Note: Templates are initially installed to <QPR 8 installationroot>\Web Application Server\Templates\Portal, but they are copiedto the path indicated above during the first startup and used fromthe All Users profile (ProgramData folder in Vista and later versions)location, so all customizations should be made to those templates.


Note: Templates are initially installed to <QPR 8 installationroot>\Web Application Server\Templates\Portal, but they are copiedto the path indicated above during the first startup and used fromthe All Users profile (ProgramData folder in Vista and later versions)location, so all customizations should be made to those templates.

SC templates


7.5 <QPR 7 installation root>\Web Application Server\Templates\SC

7.6 <path to All Users profile>\Application Data\QPR Software\QPR 7\7.6\Templates\WAS\SC

Note: Templates are initially installed to <QPR 7 installationroot>\Web Application Server\Templates\SC, but they are copied tothe path indicated above during the first startup and used from theAll Users profile (ProgramData folder in Vista and later versions)location, so all customizations should be made to those templates.





PG templates


7.5 <QPR 7 installation root>\Web Application Server\Templates\PG(Basic, Frames, and No Frames folders are now found only underQPR 7\ProcessGuide\WebLayouts

Installing QPR 8.1



7.6 <path to All Users profile>\Application Data\QPR Software\QPR 7\7.6\Templates\WAS\PG

Note: Templates are initially installed to <QPR 7 installationroot>\Web Application Server\Templates\PG, but they are copied tothe path indicated above during the first startup and used from theAll Users profile (ProgramData folder in Vista and later versions)location, so all customizations should be made to those templates.

The templates for static web publishing (Basic, Frames, and NoFrames) are located under <path to All Users profile>\ApplicationData\QPR Software\QPR 7\7.6\Templates\PGStatic.







Note: During upgrades between different releases of QPR 8.1 (for example 8.1 and 8.1 SP1) the oldtemplate folder is backed up to <path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\Templates_before_<current service pack>, and you can restore customizations from there.

Preparing for Future Upgrades

Make all the customizations to the custom.css file and store all the modified images to theqprsoftware/stylesheets/customimages folder. Doing this ensures that the future upgrades will besimple, as you will only need to copy the styles in the custom.css stylesheet and the customimagesfolder to the new installation folder. It is also good to mark all customizations with easily searchablecomments to make it easier to transfer them into a new version.

Installing QPR 8.1


4.4 Modify

You can use the modify installation to add or remove installed features after the actual QPR 8.1installation. To modify your selection of installed features, follow the instructions below:

1. Go to Control Panel -> Add or Remove Programs.2. Select QPR 8.1 from the list and click the Change button. 3. Click Next in the Welcome dialog.4. Select the Modify option and click Next.5. The Custom Setup screen opens. Select the features you want to have installed or removed,

and click Next.6. The Select Additional Tasks screen opens. Select the tasks you want to include in the modified

installation and click Next.

Note: If you had desktop icons installed before modifying the installation, select the desktopshortcuts to be installed to prevent the desktop shortcuts from being removed during themodification. Leaving the service option unchecked removes the QPR Service and comparativelyenabling the service option installs QPR Service.

7. The Ready to Modify the Program screen opens. If you need to change any settings, clickBack and make the necessary changes. Once you are satisfied with the settings, click Install tostart the installation. At this point you may be requested to browse the original QPR8Setup.exefile (i.e. the one you originally installed the software from) when adding QPR Web ServicesFoundation and/or QPR Add-In for Microsoft Office to the installation. This is needed so that theinstallation program can extract and install additional dependencies that the aforementionedcomponents need in order to function properly.

8. The modify installation is now complete. Click the Finish button to exit the installation.Depending on what additional dependencies were installed, you may need to restart yourcomputer.

4.5 Uninstallation

During uninstallation, the 8.1 folder under the common application data (C:\ProgramData\QPRSoftware in Windows Vista and later versions and C:\Documents and Settings\All Users\ApplicationData\QPR Software in older versions of Windows) is copied to 8.1_old (or old1...oldN in the case morebackup folders exist), and you're asked whether you want to remove the folder. In the case you haveany customizations or you have used the example Access database, it is safer to answer No anddelete the old settings only after you've checked that you have all the material you want to keep withyou.

Note: If you are using QPR Web Services Foundation, it is recommended to either restart thecomputer or run iisreset before the uninstallation to make sure that there are no processes keepingthe installation directory reserved.

Installing QPR 8.1


4.6 Troubleshooting

This chapter provides help on the problems you might encounter during QPR 8.1 installation.

Q: I just installed QPR 8 to a machine containing also a QPR 7 installation, and my server componentswon't start.

A: Both QPR 8 and QPR 7 servers use the same default ports, so in the case you have e.g. QPR 7running as a service in the background, the ports are already in use, and you must either shut downthe QPR 7 servers or change the ports QPR 8 is using.

Q: I just modified my QPR 8.1 installation, but my QPR User Management Server won't startanymore.

A: Launch QPR Product Activation Wizard to see your product activation status. Note that a Modifyinstallation won't require reactivation unless you install some previously uninstalled items that requireactivation. Even if this is not the case, your transient product activation might have expired. If theproduct activation status is correct, launch the QPR Configuration Manager and go to the Databaseoperations section. See that the data source is correct. Click the Test button to test your databaseconfiguration.

Q: I'm using QPR with Oracle in a 64-bit Windows environment, and despite having a 32-bit ODBCdata source configured for Oracle I cannot get QPR products to connect to the database.

A: This is due to a known issue with Oracle. The reason for the error is that the default installationpath (C:\Program Files (x86)\QPR 8.1) contains parentheses in the path name and Oracle cannothandle them properly. To avoid this problem, install QPR to a folder that's not located under theProgram Files (x86) folder. NOTE: Switching to the "regular" Program Files folder in 64-bit systemsdoes not work as 32-bit applications (such as QPR) are automatically directed under Program Files(x86) in the case you are trying to install under Program Files.

QPR Product Activation


5 QPR Product Activation

QPR Product Activation is a system to make the installation and implementation of QPR productsflexible and easy. QPR Product Activation consists of Product Activation Server and Product ActivationWizard (QPR.WLT.exe). QPR Product Activation Server records all activation transactions and providesreports of the aforementioned transactions, i.e. the QPR Product Activation Wizard takes care of theproduct activation process at the client side.

Term 'product activation' is used instead of 'licensing' when organizations install QPR Products. Tomake things more clear, term 'License' refers to Agreement between organization and QPR SoftwarePlc. about which product(s), how many users and for what time period the organization may use theproduct legally. Term 'product activation' refers to process with supporting system that is used toactivate installed QPR Product. It is organizations' responsibility to control that activated productsadhere to the license agreement.

QPR 8.1 License Agreements have three different license types:Persistent License – Organization can use the activated Product without any time limitations.Transient License with fixed expiration date – Organizations can use and fully utilize theactivated product until expiration date. After license expiration date the Organization must renewthe License Agreement.Transient License with fixed expiration time – Organizations can use and fully utilize theproduct for a fixed time period after activation. After activation expiration date the Organizationmust reactivate the product. This model is useful for ASP type of business.

QPR Product Activation Server takes care of Organization's Activation Accounts and secured Internetconnections. Licenses allow QPR products to be activated. Activation supports three differentmethods:

Automatic Product Activation via Web –Organization can activate the product automaticallyover the Internet and start using the software immediately.Manual Product Activation via Web - Organization can activate the product using theirdefault Browser and start using the software immediately. There is also a web site http://licensing.qpr.com that can be used to manually activate the product from any PC that isconnected to Internet.Manually via Phone/email – Organization can activate the product by calling or e-mailing toQPR Customer Care.

Manual product activation via Web differs from automatic product activation only so that defaultbrowser is used for communicating with the QPR Activation Server. QPR Product Activation Wizardgenerates a small HTML file that is opened with the default browser to POST activation information toserver. User only has to copy the Activation Key manually from the browser window to the Wizard.QPR Product Activation Wizard has been revised to use standard HTTP port 80 with encryptedmessages to communicate with the QPR Product Activation Server. QPR Product Activation Wizardalso supports reactivating transient licenses silently.

QPR 8.1 Product Activation supports all above-mentioned license types and two types of softwareevaluations:

Built-in 14-day evaluation period – Organization can activate a 14-day evaluation once perworkstation immediately after the software has been installed.Extended evaluation is possible with a valid Evaluation Product Activation Code.

The QPR license policy in a nutshell is as follows. For more information, refer to the QPR LicensePolicy section.

All QPR maintenance customers will get a Product Activation Code that must be used whenproducts are activated.With a valid Product Activation Code, an organization can activate every QPR software for asmany users as needed.

http://licensing.qpr.com




QPR Product Activation Server records all activations applied by Product Activation Code.Every Development Client must be activated separately.

QPR Customers need to activate the product each time aServer installation is done.Development Client installation is done.Number of registered users in the User Management System exceeds the number of activatedusers

For the abovementioned tasks you need to have a valid Product Activation Code, which is deliveredwhen the software is purchased. Product activation is supported by QPR Customer Care (contactinformation available in the QPR web site) in all matters related to product licenses and activation.Check the process maps in the following chapters for details.

In a nutshell, QPR 8 Product Activation offers the following benefits:Installing and implementing QPR product is flexible and easy.Organizations can track the usage of activated QPR products.License policy supports System Standalone usage with development clients.



5.1 Activating the Software

Activating purchased QPR Products has been made as easy as possible with automatic activation viaweb. As a last step of QPR 8 installation, the QPR Product Activation Wizard is launched in the caseyou select so. The QPR Product Activation Wizard guides you through the process providing you withthree different activation methods:

Automatic Activation via Web –Organization can activate the product automatically over theInternet and start using the software immediately.Manual Activation via Web - Organization can activate the product using their defaultBrowser and start using the software immediately. There is also a web site http://licensing.qpr.com that can be used to manually activate the product from any PC that is connected toInternetManual Activation via Phone/email – Organization can activate the product by calling or e-mailing QPR Customer Care.

During the activation, you'll also need to define the correct amounts of Portal Communicator andPortal Viewer user activations as well as the amount of QPR ProcessGuide and QPR ScoreCardDesigner user activations. Also make sure that the activated amounts are covered by your license.Note that the Designer activations do not affect QPR ScoreCard and QPR ProcessGuide web clients.There are also checkboxes for defining what components will be activated.





With the first two options it is no longer necessary to contact QPR Customer Care to activate thesoftware. The QPR Product Activation Server works 24 hours a day 7 days a week listening foractivation requests. The only thing needed is a valid Product Activation Code. Product ActivationCodes are automatically created and sent to all QPR maintenance customers.The following process drawing describes the whole product activation process and the roles of QPRPartners and QPR:



5.1.1 Automatic Activation via Web

Automatic Activation via Web is the easiest and quickest method of activating a QPR softwareproduct. Automatic Web Activation uses standard HTTP port 80 connections with encrypted messagesto communicate directly with QPR Product Activation Server. The QPR Product Activation Wizardhandles all steps necessary for activating the software:

Enter your Product Activation Code and user information.Select the Automatically via Web activation method.Wizard creates a HTTP connection to the QPR Product Activation Server and sends encryptedinformation to server.Product Activation Server records user information and sends an Activation Key back to theWizard. You will get an activation status confirmation message by e-mail.The QPR Product Activation Wizard shows a report about the activation and you can start usingthe product.

Following process drawing illustrates the process of activating a QPR product automatically over theInternet:



5.1.2 Manual Activation via Web

Manual Activation via Web uses a Web Browser to communicate with the QPR Product ActivationServer. The QPR Product Activation Wizard launches your default browser to send encryptedActivation Information automatically to the QPR Product Activation Server. These are the steps formanual activation via web:

Enter your Product Activation Code and user information.Select the Manually via Web activation method.The QPR Product Activation Wizard launches your default Web Browser to send encryptedActivation Information automatically to the QPR Product Activation Server.Activation Server records user information and generates Activation Key(s) to Web page. Youwill also get an activation status confirmation message by e-mail.Copy and paste the Activation Key(s) to the QPR Product Activation Wizard and you can startusing the product.

There is also a web site http://licensing.qpr.com that can be used to manually activate the productfrom any PC that is connected to Internet. All you need to have available is the Computer Code andProduct Activation Code. Computer Code can be found in QPR Product Activation Wizard's"Instructions for Manual Product Activation", which can be saved to a file.

Following process drawing illustrates the process of activating a QPR product manually over theInternet:




5.1.3 Manual Activation via Phone/Email

Manual Product Activation via Phone or email is convenient if there is no Internet connectionavailable. To activate a product, you need to phone or e-mail QPR Customer Care. The QPR ProductActivation Wizard gives detailed instructions on doing this. These are the steps for manual productactivation via phone or e-mail:

Enter your Product Activation Code and user information.Select the Manually via e-mail / phone activation method.Wizard shows instructions for manual product activation. Copy the instructions to clipboard orsave them to a file for printing.Contact QPR Customer Care by phone or e-mail. If e-mail is used, Product Activation Code anduser information must be included in message.QPR Customer Care handles activation requests and provides you with an Activation Key. E-mailactivation requests are handled within one business day. You will also get an Activation Statusconfirmation message by e-mail.



Enter the activation key to the Wizard and you can start using the products.

Note that there is also a web site http://licensing.qpr.com that can be used to manually activate theproduct from any PC that is connected to Internet. All you need to have available is the ComputerCode and Product Activation Code. Computer Code can be found in QPR Product Activation Wizard's"Instructions for Manual Product Activation", which can be saved to a file. The file also includes otherrelevant activation related information, such as the number of licenses you have requested for eachapplication.

Following process drawing illustrates the process of activating the software via email/phone:




5.1.4 Silent Product Activation

QPR Product Activation can also be performed silently (i.e. so that no QPR Product Activation Wizardis displayed). The silent activation can be started in two ways:

1. Launching QPR.WLT.exe with a /SILENTACTIVATION option2. Having the UseSilentForFirstActivation option in QPR.ini set to 1 (true)

In the case the command line option is used, the wizard will check whether the following informationexists in QPR.ini:

Product Activation CodeE-mail addressFirst NameLast NameCountry

If all these are present, the silent activation is started. If some of the abovementioned information ismissing, the QPR Product Activation Wizard is started in the normal mode.

In the case the UseSilentForFirstActivation options is used, the following prerequisites must be met:

Product Activation Code is in the QPR.ini fileE-mail address is in the QPR.ini fileCustomer's name is in the QPR.ini fileActivation status file is clean (i.e. right after the installation and the product has not beenactivated previously or the 14-day evaluation period used)

If all the abovementioned requirements are met, the silent activation is started. Otherwise the QPRProduct Activation Wizard is started in the normal mode. Note that the command line option overridesthe QPR.ini setting, so even if the UseSilentForFirstActivation setting would be 0 (false), and thecommand line option is given, the activation is started in the silent mode providing that all thenecessary information is included in the QPR.ini file.

5.1.5 Installation and QPR.ini

QPR.ini is a configuration settings file that is used by all QPR software components. QPR ProductActivation Wizard uses QPR.ini to store the activation server connection configurations and CustomerInformation. There is a key for every Customer Info field used in Wizard.

With QPR 8.1 it is possible to copy existing QPR.ini file with proper Customer Information filled in tobe used with installation program. Functionality has made so that if there is QPR.ini file located insame directory as QPR8Setup.exe (installation package) installation program will copy that file to theQPR 8 installation folder. This feature can be used to create 'Custom' installation packages with validProduct Activation Code included in QPR.ini.



5.2 Evaluating the Software

The QPR Product Activation Wizard supports built-in 14-day evaluations that can be activated onceper workstation. Extending the evaluation period is possible with a valid Evaluation Product ActivationCode. All supported activation methods are available for extending evaluation.

5.3 QPR License Policy

Every organization must purchase a license that allows them to activate an adequate number ofclients and users to cover the usage of QPR 8 software. QPR and QPR Resellers provide a uniqueProduct Activation Code for each customer for installing the software. Customers are responsible forthe use of their own Product Activation Code. Customer may change the Product Activation Code bysending a request to QPR Customer Care.

Product Activation Code is the entry for QPR Product Activation Server's product activation account. Allproduct activations applied with the Product Activation Code are recorded to the correspondingproduct activation account. Organizations may request activation status reports from QPR CustomerCare. The Product Activation Code is also stored in the qpr.ini file in a plain text format for further



reference. Same Product Activation Code is used for all QPR products.

The license policy affects the applications as follows: Application servers check from the QPR User Management Server whether they are allowed tostart. In the case any number of users exceeds the number of activated users, the startup failsfor QPR ScoreCard and QPR ProcessGuide servers. In addition, in the case there are more usersthan the activations allow, warning messages are displayed in the QPR User ManagementServer log file.Designers require a separate activation (by checking the corresponding checkboxes whenactivating QPR Server) and their usage is independent of the QPR Server activation.

Number of Portal Communicator and Portal Viewer users as well as the number ProcessGuideDesigner and ScoreCard Designer users must be defined when activating the QPR 8 installation. ThePortal rights allow the use of all parts of Portal, i.e. Designer activations do not affect the use of QPRScoreCard and QPR ProcessGuide Web Clients. In the case of QPR Portal, users with administrative orupdate rights are considered as full users and require a full user activation, while users in View rightsto QPR Portal require Viewer activations.

5.3.1 Transient Licenses

QPR supports also a new Transient license type. Transient license agreement defines a fixed periodof time for using the product. With QPR Product Activation Server Transient License Account there canbe a fixed expiration date or a number of days the software can be used after activation. Definitionsfor transient license types:

Transient License with fixed expiration date – Hard Date Expiration. License ExpirationDate is defined in QPR Product Activation Server's license account. Organizations can activateand use the product(s) with Transient Product Activation Code until the expiration date. Afterexpiration date the Organization must renew the License Agreement.Transient License with fixed expiration time – Soft Date Expiration. Number of LicenseExpiration Days (0-9999) is defined in QPR Product Activation Server's license account.Organizations can activate and use the product(s) with Transient Product Activation Code for afixed number of days after activation. After expiration date the Organization must reactivate theproduct with Transient Product Activation Code.

Transient license with 0 (zero) day soft expiration is a special case that can be used for example pay-per-use type of business models. Zero day soft expiration means in practice that the product must bereactivated every day it is used. QPR Activation Wizard supports this model by providing a possibilityto reactivate a transient license silently. Silent reactivation for transient license can be set easily bychanging QPR.ini configuration file (see chapter Transient Product Activation).

Example1:Organization rents a QPR Product for 6 months. The calendar period is agreed to be June 1st 2003 –December 31st 2003. Transient License Account with December 31st 2003 as hard expiration date iscreated and the Organization gets a Product Activation Code for product activations. The Organizationcan activate the product freely with transient product activation code between June 1st 2003 andDecember 31st 2003. Product activation expires on December 31st 2003 and the software cannot beused on January 1st 2004.

Example2:Organization makes a pay-per-use agreement with an ASP provider for using QPR Products. TransientLicense Account with 0 (zero) day soft expiration days is created and the Organization gets a ProductActivation Code for product activations. Every time the product is started, silent reactivation is done to



QPR Product Activation Server. The ASP provider gets activation reports from QPR Software Plc. andcharges the organization based on actual usage.

5.3.2 Transient Product Activation

QPR ScoreCard Designer, QPR ProcessGuide Designer, and the QPR User Management Server nowsupport transient product activations. There are two settings in QPR.ini file that affect the activationbehavior:

ShowTransientExpirationWarning is an integer value of 0 - n days that defines how many daysbefore transient expiration date the warning messages are shown. If the value is 0 thewarning messages are not shown.UseSilentForTransient is Boolean (values 0 / 1) flag that defines if silent reactivation is usedwhen transient expiration has occurred. If the value is 1 (true), development client tries tostart Product Activation Wizard in silent mode to reactivate the client. Wizard uses automaticproduct activation via web silently if a valid Product Activation Code can be found in QPR.ini.

Users can also see the product activation status with Product Activation Code from designer's AboutBox. This makes it easy to check the Product Activation Code when contacting QPR Customer Care.QPR Product Activation Wizard can also be launched from the About Box

5.3.3 License Types

QPR 8 is sold with four different license types. See the table below for information about how thesoftware components correspond with the current pricelist:

License in Pricelist Software Component

Designer Development client

Communicator Portal (with full rights)

Viewer Portal (with view rights)

Server Server

Designer licenses grant named individual users right to use either QPR ProcessGuide or QPRScoreCard depending on the license. The amount of purchased developer licenses must correspond tothe amount of users who have been granted access to QPR ProcessGuide or QPR ScoreCardDevelopment Clients.

Viewer licenses grant individual users rights to browse information in QPR Portal. However, users withviewer licenses cannot neither input data to QPR Portal nor create bookmarks or some otherpersonalized information. The amount of purchased viewer licenses must correspond to the amount ofusers who have been granted access to QPR Portal with View rights.

Communicator licenses grant individual users rights to utilize the full potential of QPR Portal byentering data into measures, creating actions, creating bookmarks as well as creating booklets. Theamount of purchased full licenses must correspond to the amount of users who have been grantedaccess to QPR Portal with Update rights or greater. Note that in the case the amount of users needingPortal viewer licenses exceeds the amount of purchased Portal viewer licenses, also Portal full licensescan be used for these users providing that there are spare Portal full licenses. However, theaforementioned substitution is not possible the other way around, i.e. spare Portal viewer licensescannot cover missing Portal full licenses.



Each server license gives the right to install one copy of each included server component. Thecomponents may be located on different computers as well.

See the tables below for information about how these licenses correspond with QPR UserManagement Server settings and what kind of usage the different licenses allow:

UMS access rights that can be granted with different license types:

SC Designer PG Designer Viewer Communicator

UMS View x x x x

UMS Admin x x x x

UMS Update x x x x

PG Web Basic x* x* x x

PG Web Admin x* x* x x

PG Dev Basic x

PG Dev Admin x

SC Web Basic x* x* x x

SC Web Admin x* x* x x

SC Dev Basic x

SC Dev Admin x

Portal View x x

Portal Update x

Portal Admin x

* = Indicated rights alone are not sufficient for using QPR Portal, at least Portal View rights arerequired to complement the Web Client rights

UMS View = View rights for QPR User ManagementUMS Admin = Administrate rights for QPR User ManagementUMS Update = Update rights for QPR User ManagementPG Web Basic = Basic rights for QPR ProcessGuide Web ClientPG Web Admin = Administrative rights for QPR ProcessGuide Web ClientPG Dev Basic = Basic rights for QPR ProcessGuide Development ClientPG Dev Admin = Administrative rights for QPR ProcessGuide Development ClientSC Web Basic = Basic rights for QPR ScoreCard Web ClientSC Web Admin = Administrative rights for QPR ScoreCard Web ClientSC Dev Basic = Basic rights for QPR ScoreCard Development ClientSC Dev Admin = Administrative rights for QPR ScoreCard Development ClientPortal View = View rights for QPR PortalPortal Update = Update rights for QPR PortalPortal Admin = Administrative rights for QPR Portal

Operations permitted with different license types:

SC Designer PG Designer Viewer Communicator Server

View ScoreCard models in QPRPortal

x x

View ProcessGuide models inQPR Portal

x x

Create Portal actions and enterdata to QPR ScoreCard modelsvia QPR Portal

x

Create Portal actions and enterdata to QPR ProcessGuidemodels via QPR Portal

x



Develop and Administrate QPRScoreCard models

x

Develop and Administrate QPRProcessGuide models

x

Install QPR Server components x

Limitations and Issues to NoteUsers with View rights to QPR Portal cannot input data to Processes/Scorecards tabs even thoughthey would have Administrative rights to QPR ProcessGuide and/or QPR ScoreCard.At least View rights (and thus a Viewer license) are required in order to use the QPR Portal, i.e.ProcessGuide/ScoreCard Web Client rights alone are not sufficient.Granting a user access to QPR ProcessGuide or QPR ScoreCard Web Client does not affect theamount of reserved QPR ProcessGuide/QPR ScoreCard Developer Licenses.

5.3.4 License Usage Report

You can generate a report of the license usage within your organization. To generate the report,launch QPR UMS Client from the command line with the /createactivationreport switch. You canoptionally provide also /userid <your username> and /password <your password> switches. If youuse the /userid and /password switches, the report is generated silently. Otherwise a login dialog forthe QPR UMS Client is shown.

Example 1:

QPR.UMS.Client.exe /createactivationreport

The command above opens the QPR UMS Client login dialog, and after a successful authentication thereport is created.

Example 2:

QPR.UMS.Client.exe /createactivationreport /userid qpr /password demo

The command above creates the report silently (replace the qpr/demo with your actual user account).

The report itself will be located in the Logs folder at <path to All Users profile>\Application Data\QPRSoftware\QPR 8\8.1\Logs\ by default (C:\ProgramData\QPR Software\QPR 8\8.1\Logs\ on WindowsVista and later versions). The file is called ProductActivationReport_<date and time>.txt.

The file contains information on how many licenses have been activated and how many of them are inuse. In addition, there are details available for users and groups. For different rights there's either adash indicating that the right has not been granted or an abbreviation of the granted rights. Thelegend at the end of the report lists the abbreviations.

Activation Procedure


6 Activation Procedure

Activating QPR Products is a straightforward procedure. Follow the instructions below to activate yourQPR product using the QPR Product Activation Wizard:

1. In the welcome page you can select the activation method and need to input your customerinformation. You can also view your current activation status by clicking the Activation Statusbutton at the bottom left corner. If you don't have a product activation code yet, you can choosethe 14-day evaluation activation provided that you haven't already used the evaluation period. Inthe case you select to activate using your product activation code, input the code into thecorresponding field. If you have forgotten your product activation code or your 14-day evaluationperiod 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 leastall 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 sentto QPR during the activation.

2. The License Agreement is displayed. After reading the license agreement, tick the "I accept thelicensing terms" checkbox and click the Next button to continue.

3. The "Select Number of Licenses to be Activated" page is displayed at this moment. You can selectto activate the QPR ProcessGuide and QPR ScoreCard Designers as well as the QPR Server bychecking the corresponding checkboxes in the QPR Product Activation section. Input the amount ofpurchased QPR ProcessGuide Designer and QPR ScoreCard Designer licenses into thecorresponding fields as well as the amount of QPR Portal Communicator and Viewer users into theirrespective fields. Viewer users are users with view-only rights to QPR Portal while Communicatorusers have update rights or greater. After verifying that the numbers correspond to the amount oflicenses you have purchased, click Next to continue.

4. Define the activation method. You can choose to activate the software automatically or manuallyvia Web or manually via phone or e-mail. After selecting the method, click Activate (or Next, ifyou selected manual activation via phone or mail). In the case you selected automatic activation viaweb, the product is now activated automatically. In the case you selected manually via web, theQPR Product Activation Wizard launches your default web browser and connects to QPR's licensingserver. The web page that is displayed contains your Product Activation Keys. Input the keys intothe corresponding fields in the QPR Product Activation Wizard and click Next to continue. In thecase you chose to activate the software manually via phone or mail, follow the instructions given inthe QPR Product Activation Wizard. After receiving the Activation Keys, go to the page following theinstructions and input the key into the corresponding product fields in the Activation Keyssection. Click Next to continue.

5. As the final stage, your new activation status is displayed. Please check that the information iscorrect and click Finish to close the QPR Product Activation Wizard.

Installing QPR ScoreCard Integration Kit


7 Installing QPR ScoreCard Integration Kit

The QPR ScoreCard system supports integration to external data through SQL import and OLAPimport. QPR ScoreCard Integration kit requires that Microsoft SQL Server is used.

QPR ScoreCard Integration Kit is installed by running database scripts to database.1. Start your favorite SQL Query tool.2. Log on to database with the same login id as QPR products are using.3. Open the following files and execute them

SC_Import_ValuesSQLServer.sqlsql_QPR_ReportingViews.sqlsql_QPR_ReportingProcedure.sql

If you install the reporting procedure you must have installed the reporting views before.Finally the database job can be installed.

Note: SC_ReportingUpdate database job must be installed by database admin.

Configuring QPR Installation


8 Configuring QPR Installation

8.1 QPR Configuration Manager

The QPR Configuration Manager is a tool that is used to configure all installed QPR products.

QPR Configuration Manager Error HandlingThe QPR Configuration Manager will display a warning icon next to a field where inappropriatevalues are entered. In addition, the field containing the inappropriate value is highlighted in red. Thewarning icon disappears after a proper value is entered and the highlighting disappears when aproper value is entered and some other field is selected.

Configuration FilesThe QPR Configuration Manager reads and writes changes to the qpr.ini-file located in the <path toAll Users profile>\Application Data\QPR Software\QPR 8\8.1\Settings\<possible instance folder> folder or the C:\ProgramData\QPR Software\QPR 8\8.1\Settings\<possible instance folder> inWindows Vista and later versions (not the QPR 8 installation folder, which is C:\Program Files\QPR 8by default). There are also other qpr.ini-files, but those are not modified by the QPR ConfigurationManager. See the Appendix A in the QPR - Administrator's Guide for further details on these ini-files.

8.1.1 Common Settings

The Common page allows you to define settings that are common to all the installed QPR productssuch as the default language, E-mail settings, alert settings, and shared resources.

Installed QPR ComponentsThe installed QPR components are shown in this section. To disable a component from the view onthe left side, remove the selection from the checkbox for the component.

LanguageIn the Language section you can define the default language for QPR products from the drop-downmenu. The default language setting affects the language that is used in login screens and is also thelanguage that all the new users will be using when they log into the software for the first time. Userscan override the default language by selecting another language for themselves. However, loginscreens will always use the default language.

User Interface PreferencesYou can select the skin used in all QPR client applications from the "Skin Name" drop down menu. Thedefault setting is "QPRBlue". Selecting "<None>" will disable the skinning and make the applicationsuse the native Windows theme. Note that if you have other QPR client applications running when youchange the skin, you need to restart those other applications for the setting to take effect in them.User interface modes supported by QPR are the QPRBlue skin and the skinless mode (i.e. "<None>" isselected as the skin). Other skins are provided "as is" and they are not guaranteed to be fullycompatible with QPR products.

E-mail Settings



In this section you can define settings for QPR Portal's and QPR ScoreCard's e-mail alerts andnotifications.

In the SMTP-Server field you need to define the SMTP server for the administrator's e-mail address.The address is usually smtp.yourmailprovider.com. If you want to use some other SMTP port than thedefault one, remove the selection from the checkbox and define the port number in the Port field.

Check the Use authentication checkbox in the case your SMTP server requires authentication andprovide the corresponding user name and password combination into the SMTP user name andSMTP password fields.

Enter the e-mail address where the error messages will be sent to the Administrator e-mailaddress field.

In the Reply address field enter the address that will appear as a sender's e-mail address and willalso act as a reply address for users of the e-mail notification system.

Alert SettingsCheck the Enable e-mail alerts checkbox to set the User Management System to send youmessages about certain User Management Server errors and events.

In the Enable alerts for field you can select the cases where e-mail alerts are sent. With theSystem notifications option checked the administrator will receive notifications of basic systemfunctions like starting or stopping the User Management System. With the Critical errors optionchecked the alarm message is sent in cases when the User Management Server is shut down due to acritical error.

Shared ResourcesFrom the Shared Resources section you can enter the root folder for all the installed shared resourcesin order to view e.g. common settings as well as define the folder where server cache files are stored.The folder in which the data root is located is <path to All Users profile>\Application Data\QPRSoftware\QPR 8\8.1\ (C:\ProgramData\QPR Software\QPR 8\8.1 on Windows Vista and later

versions). To view the folder containing the shared resources, click the Open folder button .

The Cache folder settings defines where cached files (e.g. cached models) are stored. By default afolder called Cache under the data root is used, but if you need to change the folder, define a new

folder by clicking the Browse button and locate the correct path. To view the contents of the

current cache folder, click the Open folder button .

Script SettingsIn this section, you can define settings for executing scripts in QPR products.

In the Script security section you can define where scripts are allowed to run. You can disable theuse of scripts by selecting No scripts allowed to run, selecting the As previous, IWA allowedoption will enable scripts in all development clients and Windows Explorer, and in addition IntegratedWindows Authentication is allowed.

To set a default script timeout for scripts that do not contain the setting themselves, enter a numberin the Default script timeout field. The value is the interval (in seconds) for displaying a notificationabout a time-consuming script being executed. Setting this value to 0 disables the notification.



8.1.2 Database Operations

On the Database operations page you can define database settings and perform database operations.

DatabaseIn this section you can define the database instance that is used by all QPR products. Select thedesired ODBC data source from the Data source drop-down list and provide the required databaselogin information to the User name and Password fields.

The database operations you can perform include testing the database configuration, creating a newdatabase, importing a database from a file or exporting a database to a file. With the Test database configuration option you can verify whether your database has beenconfigured properly. The database that will be tested is the data source that has been selected in the Data source field in the Database section. Click Test to test the database configuration.

You can also create a new database with the Create database option. This operation will create anew database on the data source selected in the Data source field in the Database section, and allthe previous contents of the database will be erased. Click Create to create a new database. Awarning message will then be displayed stating that all the information on the selected database willbe lost. Verify once more that the database does not contain any important information and thenclick Yes to create a new database. If you are importing a database from a file you need to define the location of that file on the Importdatabase section. You can either type in the path and the name of the file straight on the text fieldor alternatively you can use the Browse... button to locate the file. The import's target database isthe data source that has been selected in the Data source field in the Database section. ClickImport after defining the location of the file to perform the operation. If you are exporting a database to a file you need to define the location of that file on the Exportdatabase section. You can either type in the path and the name of the file straight to the text field oralternatively you can use the Browse... button to locate the file. The database that will be exportedis the data source that has been selected in the Data source field in the Database section. ClickExport after defining the location of the file to perform the operation.

8.1.3 Server Locations

On the Server locations page you can define settings for all the servers.

User Management ServerThe Server location field defines the location of the QPR User Management Server. You can useeither the IP address or the name of the computer running the QPR User Management Server.

The socket communication port is used in communication between the QPR UMS server, the QPR UMSclient and the QPR applications. In the Port selection section you can choose what port the UserManagement Server will use. If you do not want to use the default port, select the Custom portradio button and enter a desired socket port value into the Custom port number field. The portvalue should be within the range of 1 to 65535. However, the lowest numbers should not be used asthose are used by standard TCP/IP services.

Select the Use encrypted communication checkbox to encrypt all communication between QPR



User Management Server and the other QPR server components as well as between QPR UserManagement Server and Client.

The Password field defines the server password for the QPR User Management System. Thispassword can be used for logging into the QPR User Management Client even if there are no usersthat are allowed to access the QPR User Management Client. Note that you should change thispassword the first time you run the configuration utility to avoid security risks introduced by leavingthe default password intact.

ProcessGuide ServerThe Server location field defines the location of the QPR ProcessGuide Server.

In the Port selection section you can choose what port the QPR ProcessGuide Application Server willuse. If you do not want to use the default port, select the Custom port radio button and enter adesired socket port value into the Custom port number field.

The Use encrypted communication checkbox enables or disables the encryption.

ScoreCard ServerThe Server location field defines the location of the QPR ScoreCard Server.

The QPR ScoreCard Server uses TCP/IP sockets for communicating with the Development and Webclients. Default port for sending and receiving data is 20761. If you do not want to use the defaultport, select the Custom port radio button and enter a desired socket port value into the Customport number field. Note: The Development and Web clients must be configured for the same port number you haveentered here. The Use encrypted communication check box enables or disables the encryption.

Web Application ServerThe Server location field defines the location of the QPR Web Application Server.

In the Port selection section you can choose what port the QPR Web Application Server will use. Ifyou do not want to use the default port, select the Custom port radio button and enter a desiredsocket port value into the Custom port number field.

Note

If you change the port, you need to change the same value also tothe qprsettings.dat file located in the CGI-binary folder.

8.1.4 Server Log Settings

In the Server log settings section you can define the folder in which the log files are stored. By defaultthis is <path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\Logs\ (C:\ProgramData\QPR Software\QPR 8\8.1\Logs in Windows Vista and later versions), but you can

change it by clicking the Browse button and then locating the desired path. By clicking the Open log folder button you can view directly the contents of the folder that you have defined as the



folder for storing the log files.

You can define the maximum size of log files by entering the value in the Maximum log file size(MB) field separately for each server. The value is set in megabytes (MB), and by default the value is25 MB. If the maximum log file size is reached, new entries will be written over the oldest entries.

You can also choose whether to force different logging options. The options are:Force normal trace mode for all products: All server components and Web ApplicationServer plugins will use the normal logging mode.Force full trace mode for all products: All server components and Web Application Serverplugins will use the full trace logging mode.Custom trace mode for each product: With this option you can select the logging modeindividually for the server components and Web Application Server plugins.

In the Normal mode only errors are written to the log file. In the Full Trace mode all server messagesare written to the log file. In most cases the Normal mode should be sufficient.

You can enable audit logging for QPR ScoreCard Server and QPR ProcessGuide Server by selecting theappropriate Logging enabled radio button. When the audit log is enabled, all QPR ScoreCard Servermeasure changes are recorded into the SCSAudit.txt file and all QPR ProcessGuide Server operationsto a model into the PGSAudit.txt file located in the log files folder defined in the Folder field above.For more details about the audit log, refer to Audit Log chapter in QPR Administrator's Guide.

The User Audit Logging for each QPR Server can be disabled and enabled by selecting Loggingdisabled, Basic logging enabled or Full logging enabled. For more details about the user auditlog, see the User Audit Log chapter in QPR Administrator's Guide.

For details about the Performance log settings, see the description for PerformanceLog key inAppendix A: Common QPR ini-file (qpr.ini) in QPR Administrator's Guide.

8.1.5 Service Operations

In the Service settings section you can define settings for the QPR Service service.

Status - Tells you the status of the NT service. Possible options are:Running - NT service is running.Stopped - NT service is stopped.Service not installed - NT service has not been installed.Status unknown - NT service is in such state, that its status cannot be read (starting, stopping)or the NT service has not been correctly installed.

Startup time - Defines the time that the NT service waits for the QPR server components to start. Ifthe server components do not start within the given time, the NT service will be stopped. Themaximum value for the Startup time is 99 minutes. You can change the value by either entering anew value manually to the field or by using the arrows on the right side of the field to scroll to thedesired value. Check status every - NT Service will check the status of the QPR server components at the givenintervals. If the QPR server components are not responding, then the NT Service is stopped. You canchange the value by either entering a new value manually to the field or by using the arrows on theright side of the field to scroll to the desired value.



Response timeout - The time how long the service waits for status check response from QPRserver components before giving an error message. You can change the value by either entering anew value manually to the field or by using the arrows on the right side of the field to scroll to thedesired value. Force kill after timeout - If checked, then the NT service and the QPR server componentscontrolled by the service are stopped by force after the given Response timeout has elapsed.

Maximum number of start attempts - The amount of times the service tries to start in the case ofcritical error in the startup. If startup has not been successful within the defined number of attempts,the startup procedure is aborted. You can change the value by either entering a new value manuallyto the field or by using the arrows on the right side of the field to scroll to the desired value.

Click the following buttons to perform a service operation as follows:

Start Service - Starts the NT service, and reports the service status in the Status field. Stop Service - Stops the NT service, and reports the service status in the Status field. Show Service Log - Shows the NT service's log.

Change Service Name - Changes the name of the NT service.

8.1.6 System Migration

In the System migration section you can transfer settings from a QPR 7.6/8.0 installation into QPR8.1 or perform additional operations to the QPR 8.1 database. Some fields are pre-filled if this sectionis opened from the QPR 8 installation.

The Source INI file path field defines the folder where QPR 7.6/8.0 settings files (qpr.ini,actiontypes.ini, and terms.ini) are located. When this value is defined by the installation, the defaultinstance is used, so you need to change the value in the case you want to migrate a differentinstance.

The Target INI file path field defines the folder where QPR 8.1 settings files (qpr.ini, actiontypes.ini, and terms.ini) are located.

In the Migrate INI files section you can select which of the three settings files to migrate:QPR.ini: The main configuration fileActiontypes.ini: Action types available in QPR PortalTerms.ini: Terminology customization file

The files are selectable in the case the corresponding files are found in the source folder and thetarget folder is defined.

In the Source database section you can define the QPR 7.6/8.0 data source from which data ismigrated to QPR 8.1. Define the data source and the user name and password (if any) required forthe database into the corresponding fields. When the migration is launched from the installation,these values are read from the default QPR 7.6/8.0 instance.

In the Target database section you can define the QPR 8.1 data source into which data is importedfrom QPR 7.6/8.0 or to which additional operations are performed. Define the data source and theuser name and password (if any) required for the database into the corresponding fields. When themigration is launched from the installation, the 8.1 demo database is suggested as the default.



Warning

Any possible QPR tables in the target database are overwritten,so make sure the database is either empty or you have up-to-date backup copies.

In the Options for database migration section you can select additional operations to beperformed during the database migration:

Migrate QPR ProcessGuide custom attributes: This option merges possible duplicate (i.e. name,description and other information match) custom attribute types into one, which is linked to allelement types that were using the previous duplicate versions. This setting is useful if you haveduplicate custom attribute types originating from e.g. a database or file models created with QPR7.5 or older. You can use this option also when you have only the target database defined.Migrate QPR ProcessGuide web publishing options: This option converts the old web publishingoptions into web styles, and overwrites any existing global web styles in the database.

Warning

Make sure to have full backups of the QPR 8.1 database beforeusing the migration options.

When the desired options are selected, click Run Migration to start the migration. After themigration is completed, you can choose to view the log file to see which operations were performed.

8.1.7 Versions

The Versions page displays all the components of the QPR package and their versions. In the casesome component is not installed, the Version field will have a "Not installed" text instead of theversion number.

8.1.8 QPR User Management Server Settings

In this section you can define settings for the QPR User Management Server.

Authentication MethodHere you can select the method which is used for authenticating the users. For example, if WindowsNT is selected, then the users are authenticated based on NT user accounts and passwords.

QPR uses users defined in the QPR User Management System.Windows NT uses NT domain users.LDAP uses LDAP authentication

Any combination of these methods can be used as long as there is at least one method selected.

Single Sign OnHere you can select the components for which the Windows Integrated Authentication (IWA) isenabled. The options are:

QPR Portal: Enables single sign-on for QPR Portal. When this option is enabled, you need to definethe CGI binary IP setting.



QPR ProcessGuide D-Client: Enables single sign-on for QPR ProcessGuide Development Client.QPR ScoreCard D-Client: Enables single sign-on for QPR ScoreCard Development Client.

In the "Generic Single Sign on (SSO) for" field you can select which components can use genericsingle sign on authentication. Currently the only option is QPR Portal, and selecting it requires that theCGI binary IP setting is defined as well as qprsettings.dat modified accordingly. See "Using SingleSign-On with QPR Products" section for more details.

Single Sign On can be used simultaneously with Windows Integrated Authentication.

The CGI binary IP field is used for defining the IP address of the computer where qpr.dll or qpr.exeresides in. This is required for single sign on authentication to QPR Portal.

User GroupHere you can select the group management method. The Synchronized with NT/LDAP option makes the User Management System groups to besynchronized with NT/LDAP groups for authentication purposes. In the case you want some usergroup to act as a default group, select the Use default user group checkbox and insert the group'sname into the Default user group field. The default user group is used when NT/LDAP users areimported, and a group with a name similar to their NT/LDAP group does not exist in UMS. For moreinformation about the default user group, refer to the NT & LDAP Authentication section in QPRAdministrator's Guide. The UMS only option means that the user groups are maintained only by QPR User ManagementSystem. With this option the groups are not synchronized with NT/LDAP groups for authenticationpurposes.

LDAP Synchronization SettingsHere you can select whether user information in QPR UMS is updated when a user logs in with an NTor LDAP account. When using LDAP and this setting is enabled, the information is updated also duringthe next synchronization if the user information has changed on LDAP. The following information isupdated in the case this setting is enabled:

Full nameE-mail (LDAP only)Telephone number (LDAP only)Description

Autologin SettingsHere you can define options for cookie-based automatic login to QPR Portal. There are three optionsto choose from:

Enable autologin with cookies as default option. With this option there is a "Loginautomatically next time" checkbox at Portal's login screen and it is checked by default. Users wholeave the option on have their login information stored in a cookie and can login to Portalautomatically after the first login unless they explicitly remove the cookie (either from thebrowser's settings or by clicking the "Clear automatic login information" button at Portal's logoutscreen.Enable autologin with cookies option. With this option there is a "Login automatically nexttime" checkbox at Portal's login screen. The checkbox is unchecked by default, but otherwise thefunctionality is similar to the previous option.Do not use cookies for autologin. The "Login automatically next time" option is not displayed



and cookie-based automatic login is not possible.

8.1.9 LDAP Settings

LDAP (Lightweight Directory Access Protocol) can be used to import users into the QPR UMS (UserManagement System). The LDAP Settings page requires some specific information and settings ofyour LDAP server. If you do not know the required information, you should contact your LDAPadministrator.

LDAP SettingsEnter the address of the LDAP server in the Server address field.

In the Search base field, enter the value that corresponds to that which is set in your LDAP server. In the Naming convention drop-down list, you can select from two options: "Standard" and "ActiveDirectory". The selected Naming Convention defines what kind of naming conventions are used forLDAP connection parameters. The "Standard" setup is used to communicate with, for example, LotusNotes. Whereas the "Active Directory" setup is used to communicate with Windows Active DirectoryLDAP. In Secure connection, select the "Always use secure connection" option to verify that only secureconnections can be used. If you want only the authentication via a secure connection, select the"Authenticate via secure connection" option. If you do not want secure connections to be used at all,select the "Never use secure connection" option.

Secure connections with LDAP mean that the connection is made via Secure Socket Layers (SSL). Inorder for SSL connections to work correctly, the following 3 preconditions must be met:

1. The LDAP server must support and accept connections via SSL.2. The SSL certificate of the LDAP server must be signed by a certificate authority, which is

trusted by the computer on which the UMS server runs.3. The hostname of the LDAP server's certificate must match the name which is used to connect

to the server. (i.e. it must be the same as the contents of the "Server address" field in thecurrent page, "LDAP Settings", of this configuration utility).

Enabling trust for a certificate authority (i.e. fulfilling precondition 2) is done in Windows by addingthe certificate authority's certificate to the list of "Trusted Root Certification Authorities". For furtherinformation about enabling trust for certificate authorities, consult your Windows supportdocumentation.

Note that currently a secure LDAP authentication requiring a client certificate is not supported.

LDAP Setting GroupThe Standard/Active Directory setup information can be modified in this section.

Setting Description

Distinguished name attribute Attribute name of an LDAP directory entry, which identifiesthe DN of the entry.

Common name attribute Attribute name of an LDAP directory entry, which identifiesthe full user name of the entry. When importing users, this ismapped as the user name of the user.



Setting Description

Person full name attribute Attribute name of an LDAP directory entry, which identifiesthe full name of the user. If the value is not defined explicitly,the default value is used, i.e. the value set to Common nameattribute. If the value is defined, it overrides the defaultvalue.

Email attribute Attribute name of an LDAP directory entry, which identifiesthe email address of the entry. When importing users, this ismapped as the email address of the user.

Member attribute Attribute name of an LDAP directory entry. This attributeidentifies one group member. An entry having this attributerepresents some kind of group. The entry has one (Memberattribute, DN of themember) pair for each of its members.

Description attribute Attribute name of an LDAP directory entry, which identifiesthe description of the entry. When importing users, this ismapped as the description of the user.

Filter for searching groups Groups are retrieved from the LDAP directory using thissearch filter.

Filter for searching persons Users are retrieved from the LDAP directory using this searchfilter.

Used id attribute name Attribute name of an LDAP directory entry, which identifiesthe user id (login name) of the entry. It is mapped as suchwhen importing users.

Group search base The distinguished name of the entry under which the searchis performed on. Used when searching for groups in LDAP. Ifset to <Default>, the value of SearchBase in qpr.ini is used(see Appendix A in QPR - Administrator's Guide for descriptionof the SearchBase key).

Use Global Catalog searching for AD Defines whether Global Catalog searching for Active Directoryobjects in any domain in the forest is enabled.

LDAP Directory LoginAs authentication method you can select between anonymous authentication or login with user nameand password. If you select the Login with user name and password checkbox, then you shouldenter the User name and Password for the LDAP directory login in the corresponding fields.

LDAP Scheduled Synchronization SettingsThis section is used to define the LDAP scheduled synchronization settings.

Setting Description

Synchronization method Defines how UMS synchronizes users and groups withLDAP. Options: No synchronization (default),Synchronization enabled (users in groups found inboth LDAP and UMS are synchronized), Synchronization enabled, delete obsolete users (users in groups found in both LDAP and UMS aresynchronized, but obsolete users, i.e. users not foundin LDAP anymore, are moved to a group defined by Group for deleted users setting, and in the casethe group is not defined, those users are deleted.)

WARNING: In the case synchronization is used,



Setting Description

changing groups in LDAP may result in users andrelated data (actions, element owners) beingremoved from QPR UMS.

Start date and time Defines the initial start time of group synchronization.Format is datetime (yyyy-MM-dd hh:mm).

Synchronization interval (dd:hh:mm) Defines the interval between group synchronizationoperations starting from the time defined in Start dateand time. The correct format for this setting is acolon-separated list of days, hours and minutes. Forexample, if Start date and time=2008-15-0101:15 and Synchronization interval=01:00:00, thefirstsynchronization takes place on 2008-15-01 01:15 andsubsequent synchronizations are done every day at01:15.

Excluded groups (comma-separated list) A comma-separated list of groups which are excludedfrom synchronization. In the case a user belongs toany of the groups listed in this setting, thesynchronization does not affect that user. Note thatthe group name must be contained in double quotesin the case the name contains spaces.

Group for deleted users Name of the group where users not found in LDAPare moved during synchronization if obsolete usersare set to be deleted. If this is empty, the affectedusers are deleted from QPR UMS. By default this is"#Deleted users#".

8.1.10 QPR ScoreCard Server Settings

In this section you can define settings for the QPR ScoreCard Server.

Time Interval for Replica Elements RefreshHere you can define the settings for the time interval for refresh, which determines how often thereplica elements are updated. The imported element, i.e. the replica elements, are copied from ananother model and can be defined to be refreshed regularly. This can be done in the QPR ScoreCardDevelopment Client's Element Properties window's Replication Properties tab.

To change the settings, either enter a new value manually to the field or use the arrows on the rightside of the field to scroll to the desired value.

Start date: Defines the Start date for refreshing data. The updating does not take place before theStart date.

Start time: Defines the Start time for refreshing data. The updating does not take place before theStart time. The Start time can be set by an accuracy of 5 minutes.

Interval days / hours / minutes: Defines how often the replica elements are updated. TheInterval can be set by an accuracy of 5 minutes.

Remote Model Export



Here you can define the settings for responding to model requests, which determines how to operatewhen a remote server requests a model from the local server.

If the model is reserved, repeat export attempts: Tick this check box to repeat the attempt toexport the model in the cases where the model is reserved, e.g. the user is editing the model at thesame time when the remote server requests the model from the local server.

every __ seconds: Defines how often the export attempts are done. To change the value, eitherenter a new value manually to the field or use the arrows on the right side of the field.

for __ minutes: Defines how long the export attempts are done. If the model is still reserved afterthe export has been attempted long enough, the exporting of the element fails. To change thevalue, either enter a new value manually to the field or use the arrows on the right side of the field.

For example if you have defined the exporting to be done every 5 seconds for 3 minutes, theexporting is retrieved at 5 seconds intervals for three minutes or until the export succeeds.

Memory UsageThe Maximum memory usage setting defines the maximum amount of memory in megabytes thatScoreCard Server and Plugin are allowed to use before non-critical caches are cleared and all measurevalues in all models are written to QPR EMS (Extended Memory Storage). QPR EMS is used by QPRScoreCard Server and QPR ScoreCard Plugin as an extension to the memory for storing informationsuch as measure values and calculation rules. Setting this to 0 (default) disables the limit. Otherwisethe minimum value is 128 and the maximum value is 3072. This setting should be used only if you areexperiencing problems with memory consumption.

8.1.11 QPR ProcessGuide Server Settings

In this section you can define settings for the QPR ProcessGuide Server.

Cache SettingsHere you can define how long unused models will be cached, i.e. can be accessed faster. Especially inlarger organizations with lots of models in the database it is a good practice to remove idle modelssoon. That way the server has more resources available for the active models. You can define themaximum amount of days the model can be unused before it is cleared from the cache memory. Thiscan be done in two ways:

Either type in a new value to the Remove models from memory if not accessed in _ days field

oruse the arrow buttons on the right side of the field to scroll to the desired value.

You can also define a maximum server memory consumption limit for the QPR ProcessGuideApplication Server. With this option you can reduce the memory usage in the case you have manylarge models stored in the server. Note that this limit can be exceeded temporarily, since the memoryusage is checked every 10 minutes. You can define the maximum memory usage (128 minimum, 3072maximum) in megabytes to the Maximum server memory consumption field either by entering anew value manually to the field or by using the arrows on the right side of the field to scroll to thedesired value.

The Cache embedded information items to section defines how embedded information items willbe stored in the local computer. The options are:



Memory (always) The information items will always be stored in RAM. Disk (always) The information items will always be stored in files.Disk after the size exceeds (to memory before that) The information items will be stored inRAM and when the defined maximum size is exceeded, the information item will be stored in a fileinstead of memory. You can change the maximum size in the field below the option either byentering a new value manually to the field or by using the arrows on the right side of the field toscroll to the desired value.

If you select the Clear disk cache at startup checkbox, the model cache will be cleared at serverstartup. In the case this option is not selected, old cached files are utilized if their contents are up todate, thus resulting in a faster startup.

The selection in Model caching section defines how models are loaded into the QPR Web ApplicationServer at startup:

Option Description

Base and published models, drop frommemory

Base models and published models that do not have anexisting cache file are loaded from database and writtento cache. After this models are dropped from thememory.

Same as previous, drop if memory limitexceeded

Base models and published models that do not have anexisting cache file are loaded from database and writtento cache. Models are dropped from the memory in thecase the memory limit is exceeded.

Base models are loaded to cache Base models that do not have an existing cache file areloaded from database and written to cache.

No models are loaded to cache No models are loaded from the database.

Model OptionsSelecting the Enable version management for new models makes all new models use versionmanagement by default.

8.1.12 QPR Web Application Server Settings

In this section you can define settings for the QPR Web Application Server.

Session SettingsHere you can define the Expiration timeout setting. The Expiration timeout setting defines thetime how long a user can be idle before he or she has to log in again. You can change the valueeither by entering a new value manually to the field or by using the arrows on the right side of thefield to scroll to the desired value.

The Expiration timeout after logout is the time in seconds that a user's session remains activeafter logout. The setting is used in demo portals, where all users use the same User information. Ifsome user logs out, the session still remains valid for the given expiration time. Setting this value to 0(default) makes the user's session to expire immediately after logout.

Cache SettingsHere you can define the maximum amount of server computer memory QPR Web Application Server isallowed to consume. Define the desired value in megabytes to the Maximum server memoryconsumption field. The value of this setting affects e.g. the amount of models cached in the memory



and therefore also for example searches.

The % of maximum memory freed if limit exceeded setting defines the per cent value of thethreshold for the Maximum server memory consumption when the memory limit has beenexceeded, so that WAS will drop models from memory until memory usage is <value>% under thespecified Maximum server memory consumption. The default value is 20.

The Cache embedded attachments to section defines how embedded attachments will be storedin the local computer. The options are:

Memory (always) The attachments will be always stored in RAM. Disk (always) The attachments will be always stored in files.Disk after the size exceeds (to memory before that) The attachments will be stored in RAMand when the defined maximum size is exceeded, they will be stored in a file instead of memory.You can change the maximum size in the field below the option either by entering a new valuemanually to the field or by using the arrows on the right side of the field to scroll to the desiredvalue.

Web ContentHere you can define settings for the QPR Web Application Server's web contents.

Enter the location of your Web contents into the Web content URL field. This is oftenhttp://127.0.0.1/ (localhost)

Note

You cannot use http://127.0.0.1 if QPR Web Application Server isaccessed from other computers or the web server is installed onsome other computer. You have to set either the IP address or theweb server's server name (for example "myserver.com") to thisparameter instead. Users are not able to see any images ifhttp://127.0.0.1 is used.

The Web content URL field points to the location where the QPR Web Application Server's webcontent files are installed in your web server. QPR Web Application Server (WAS) uses this URL whenit generates links to the HTML files, images and other web content files that WAS and other installedQPR plugins use. The Web content URL is composed of three sections: <Connection type >://<Server name or IP address >/<Custom location of the files >/

Connection type - http - if normal web connection is used. - https - if secure (SSL) web connection is used.

Server name or IP address is an address that uniquely identifies the web server. If you use theQPR Web Application Server only on your own computer and the web server is installed on thesame computer, then you can use the local host address 127.0.0.1. If QPR Web ApplicationServer is accessed from other computers or the web server is installed on some other computer,then you have to set either the IP address or the web server's server name (for example"myserver.com") to this parameter.Custom location of the files is relative to web server's wwwroot (document root) directory, whichis the default directory from where the web server looks first for all published web content.Normally the QPR Web Application Server web content is installed directly to the wwwroot, sothis parameter is empty.

Some examples of web content URL if installed to a web server which resides at the same computeras QPR Web Application Server, and is accessed only from the same computer:



- Web content installed to wwwroot, using a normal web connection: http://127.0.0.1/ - Web content installed to wwwroot, using a secure web connection: https://127.0.0.1/ - Web content installed to directory "QPRWas" located under wwwroot, using a normal web

connection: http://127.0.0.1/QPRwas/ Some examples of the web content URL if installed on a web server which resides at "myserver.com" (IP address 123.123.123.123) and/or has to be accessible to other computers also: - Web content installed to wwwroot, using a normal web connection: http://myserver.com/ or

http://123.123.123.123/ - Web content installed to wwwroot, using a secure web connection: https:// myserver.com/

or https://123.123.123.123/ - Web content installed to directory "QPRWas" located under wwwroot, using a normal web

connection: http://myserver.com/QPRwas/ or http://123.123.123.123/QPRWas/

The Script location setting defines the exact location of the CGI binary or the ISAPI DLL file (qpr.exefor servers running the CGI binary on Windows platform, qpr.cgi on others, and qpr.dll in the case theISAPI DLL is used) as a URL. For example, http://127.0.0.1/scripts/qpr.exe In the Default login view section you can select the contents of the QPR Portal login view. Thedefault login view can be either default (QPR Homepage) or a custom address, which can be typedinto the Custom URL field.

QPR Portal Appearance SettingsThe Default Portal mode setting defines the QPR Portal mode for a user that hasn't previouslylogged into QPR Portal.

The Enable Portal mode change by user setting defines whether a button for changing the QPRPortal mode between Mini Portal and Standard Portal is shown.

The Default details pane mode setting defines the QPR Portal Details Pane mode for a user thathasn't previously logged into QPR Portal.

The Enable details pane mode change by user setting defines whether it is possible to changethe Details Pane mode in QPR Portal.

Select the Enable link to QPR FactView checkbox to have a link to QPR FactView (a tab calledAnalytics) visible in QPR Portal.

In addition, to make the QPR FactView link (Analytics tab) visible only to users who belong to aspecific group defined in the QPR User Management System, specify the group name(s) (acomma-separated list) in the QPR FactView user group field.

The Year offset for display values setting defines an offset (positive or negative) to be applied tothe year values displayed in QPR Portal to accommodate for different calendars. Note that this settingaffects only how the values are displayed, so calculations are not affected and two QPR WebApplication Servers can utilize the same database with different offsets. However, negative offsetslarge enough to cause negative year values to be displayed in QPR Portal should not be used. Notethat this setting affects also situations where action attribute values of the type date are inputted. Inthose cases a reverse offset is applied to the values before inputting them to the database in order tomaintain database consistency.



8.1.13 QPR Portal Plugin Settings

In this section you can define settings for the QPR Portal Plugin.

General SettingsRead-only mode Select this check box to set QPR Portal available in read-only mode for all users. This is useful whenyou wish to use QPR Portal in demo mode so that users cannot make any modifications, such aschanging settings, adding bookmarks, editing links and view, etc.

Note that when QPR Portal is in read-only mode, users can select the language when logging in to thePortal but the setting is only applied to the current session, i.e. it is not reused in the next session.

Allow password changingKeep this check box selected to allow QPR Portal users to change their own login password.

Note that this option is not available when Read-only mode is selected for QPR Portal.

Default Tab After LoginThe Default tab after login section defines the tab that is initially opened in the portal main viewwhen a user logs in. You can change the tab from the drop-down list. If the Allow users to changethe default tab option is checked, users can override this default tab by setting the tab they want tobe their default page in QPR Portal. This can be done by selecting the desired view, clicking thebookmark button, clicking the Set as default view button, selecting the action and users to whomthe selection is set and clicking Ok.

Default Pages on Each TabThe Default pages on each tab section is used to define the pages that are opened in the portalwhen a certain tab is selected. You can change the page from the drop-down list. If the Allow usersto change the default pages option is checked, users can override this default tab similarly as inchanging the default tab after login.

Home Page Settings The Home Page section defines the settings for the page that is displayed as the Home view of QPRPortal as well as bookmark settings.

Default Home PageIn this section you can select the contents of the Home view, the home page of QPR Portal.

Portal Home address can be either default or custom address, which can be typed to the CustomURL field. The "Custom URL" option allows you to define the web page that is shown in the homeview instead of the default page. This can be set to http://www.qpr.com, for example. This can be abookmarked view from a ScoreCard or ProcessGuide model as well. To add a bookmarked Portal viewas a custom URL, simply copy and paste the bookmark URL into the Custom URL field. You can getthe URL by opening the bookmark editor view and copying the contents of the Location field. If the Allow users to change the home page option is enabled, users can customize the home page toshow the location of any bookmark they have.

Bookmark OrderIn this section you can define how bookmarks are listed in QPR Portal.

The Show My bookmarks first and Show shared bookmarks first options define the order in

http://www.qpr.com



which the bookmarks are listed.

Default Action SettingsIn this section you can define the default action type (i.e. the type that is selected when you open theaction editor to create a new action) as well the default publishing and notification settings.

Select the default action type from the "Action type" drop-down menu. Additionally, define thedefault option for publishing actions (i.e. which users can view the action) in the "Published to"drop-down menu.

Check the "Notify via e-mail" checkbox to have the corresponding option checked by default whencreating new actions. Leave the box empty to create new actions with the e-mail notificationunchecked by default.

Default Attachment TypeIn this section you can define the default type of attachments. Select Embed attachments to useembedded attachments by default and correspondingly Link attachments to use linked attachmentsby default.

8.1.14 QPR ProcessGuide Plugin Settings

In this section you can define settings for the QPR ProcessGuide Plugin.

Page Generation and Model LoadingThis section is used to define settings for pages opened in the Processes tab in QPR Portal.

If the "Allow usage of old model version while loading" check box is checked in the Model web pagegeneration section, then old versions of process models are available for users during load of anewer version. If the box is unchecked, the old model is unavailable when the Web Client is loading anew version.

In the Models loaded at startup section you can configure which ProcessGuide models are loadedinto memory when QPR Web Application Server is started. Select the option you want from the drop-down menu. The options are:

No models: no models are loaded into memory at startup.All models: all existing models are loaded into memory at startup.Models from previous WAS session: the models that were in memory the last time QPR WebApplication Server was running are loaded into memory at startup. This list is automaticallymaintained by QPR Web Application Server.Models listed in the LoadModelsToMemory key: The LoadModelsToMemory key is a comma-separated list of model IDs of models. This setting is maintained manually in qpr.ini file. If there aremodel IDs listed in this key and this option is selected, the listed models are loaded into memory atstartup.LoadModelsToMemory and previous WAS session models: The models listed in theLoadModelsToMemory key and the models that were in memory the last time QPR Web ApplicationServer was running are loaded into memory at startup. This option is the default value.

If the "Open external models in a new browser window" checkbox is checked and the link to anexternal model is clicked, the external model is opened in a new browser window. If the option is



unchecked, the external model is opened in the current browser window. This setting can beoverridden by model-specific web publishing settings in QPR ProcessGuide Development Client.

The "Load models from cache if available" setting defines whether models in file cache are usedduring QPR Web Application Server startup in the case the model exists in cache and it is up to date.If the model is not cached or it is not up to date, the model is read from the QPR ProcessGuideServer.

What's New PageHere you can define settings for the What's new page of the QPR Portal. To load the default What'snew page settings, select the "Default" option in the Listing settings field. To use custom settings,select the "Custom" option.

If you select the custom page settings, you can set the minimum and maximum number of entries toshow for QPR ProcessGuide element types on the What's new page either by entering a new valuemanually to the field or by using the arrows on the right side of the field to scroll to the desired value.Note that these settings do not affect the Summary mode of the What's New but the listings for asingle element type instead.

You can also define the maximum number of days for which an event is displayed on the What's newpage. By default, the what's new list includes only events that have occurred within the past 7 days.

Flow ChartsThe Flow Charts section controls the settings for generating flowcharts.

The Picture storage radio buttons allow you to select whether to save the images in yourcomputer's memory or to its hard disk.

The Image format drop-down menu lets you choose whether to save the images in PNG or JPEGformat. JPEG-images are good for small and medium flowcharts whose colors are somewhathomogenous. PNG-images can be used for large files and/or files with a lot of details and differentcolors.

You can define whether there will always be links to flowcharts in the Details view by selecting theAlways provide a link to a flowchart checkbox.

8.1.15 QPR ScoreCard Plugin Settings

In this section you can define settings for the QPR ScoreCard Plugin.

General SettingsTo enable caching in browsers, check Allow browser caching. With this option selected, browserssave and fetch pages from the local hard drive instead of downloading them from the QPR WebApplication Server. However, if the model data is changed, users may not see the changes becausethey are viewing the old data stored in their computers.

The Use buffered value input check box defines whether value input is allowed when the model isreserved e.g. for recalculation. In the case buffered input is allowed, values can be input when themodel is reserved, but the new values are stored in a temporary buffer and applied to the model oncethe reservation is freed.



The Enable hyperlinks for text values check box defines whether hyperlinks are createdautomatically in QPR Portal from URLs entered as text type measure values.

What's New PageHere you can define settings for the What's new page of the QPR Portal. To load the default What'snew page settings, select the "Default" option in the Listing settings field. To use custom settings,select the "Custom" option.

If you select the custom page settings, you can set the minimum and maximum number of entries toshow for QPR ScoreCard element types and actions on the What's new page either by entering a newvalue manually to the field or by using the arrows on the right side of the field to scroll to the desiredvalue. Note that these settings do not affect the Summary mode of the What's New but the listings fora single element type instead.

You can also define the maximum number of days for which an event is displayed on the What's newpage. By default, the what's new list includes only events that have occurred within the past 7 days.

Graphical ViewsTo enable the Scorecard View in the Web Client, select the Enable graphical views checkbox.

To allow the Adobe SVG Viewer Plug-in to be installed automatically to the user's machine, select the Enable automatic viewer plug-in installation checkbox.

Select the viewer plugin you have installed from the Viewer plugin drop-down menu. In the casethis setting is incorrect, the floating toolbar in Scorecard View and Strategy Map view will not workcorrectly, so it is important that this setting matches the installed viewer version. The table below liststhe known limitations with different options:

Viewer Limitations

Adobe SVG Viewer 3 or Later None with Internet Explorer. With other browsers extra pop-up menu functionality (Show/Hide toolbar and subelements)may not work.

Microsoft Silverlight

Note that the Adobe SVG viewer's context menu may contain strings in different languages, as theSVG viewer's native strings are shown in the viewer's language, but strings specific to QPR Portal areshown in the currently active Portal language.

The Use bitmap text in graphical views checkbox defines whether the SVG/Silverlight viewsdisplay text as bitmap graphics instead of using text capabilities of SVG and Silverlight. This setting isuseful e.g. in situations where some language-specific features such as joining characters based ontheir context don't work properly.

Web File Publishing DirectoryIn the Path field, specify the directory where web published files are saved.

Select the Remove extra files at startup checkbox to clean the folder of all files before beginningany web publishing.

Warning! By checking this option, you will lose all the other files that reside in the specified folder. Itwill completely clear your directory, including anything that is not related to the web publishing files.



Web File Publishing URLsIn the Web file directory URL field you can define the location from which the QPR Web ApplicationServer can access the files to be published to the QPR Portal/QPR ScoreCard Web Client. All web-published files can then be viewed from the Reports page of the QPR Portal.

If necessary, you can define a different URL in which the reports are opened. To do this select the Use different URL for reports checkbox. When this option is selected, a suggested URL, which isbased on the Web File Directory URL, will appear in the field. You can modify the URL in the URL forreports field. Note! Even if you use reports, you do not have to use the alternative URL for the reports.

Report OptionsIn the Report file extension field, you can define the report file extension to be used.

Scorecard VisibilityFrom the Scorecard hierarchy section, select which scorecards are hidden in the scorecardhierarchy in QPR Portal, when the user doesn't have enough rights:

Show all: No scorecards are hidden.Show only accessible as a list: Scorecards for which the user has no rights are hidden,after which the scorecard hierarchy is flattened so that the remaining scorecards do not forma hierarchy.Hide inaccessible leaves: If the user doesn't have rights for a scorecard that has nochildren or the user doesn't have rights for the children, that scorecard and its children arehidden from the hierarchy. All other scorecards are left visible, even if the user had no rightsfor them.Hide inaccessible branches: Scorecards for which the user has no rights and all its childrenare hidden from the hierarchy, no matter if the user had rights for some of the children.Hide all inaccessible: Scorecards for which the user has no rights are hidden from thehierarchy and their children are attached under the deepest prevailing parent. If a user hasno rights for the parents, the children are moved to the top level.

From the Scorecard names section, select how the names of the scorecards for which the user hasno rights but still remain visible in the scorecard hierarchy in QPR Portal are shown:

Show all names: The names of the scorecards for which the user has no rights are shown,but the links are not clickable.Hide names of inaccessible scorecards: The names of the scorecards for which the userhas no rights are not shown. Instead, their names are displayed as "Access Denied".

8.2 Web Server Configuration

8.2.1 Automatic Installation of the Adobe SVG Viewer Plug-in

The Web Client Scorecard View is made viewable through a browser SVG viewer plug-in. If theautomatic Adobe SVG plug-in installation is enabled, then you will be prompted to download theAdobe SVG Viewer plug-in the first time you select to view the Scorecard View and no SVG viewer isalready installed on your machine.

NOTE: Sufficient rights for installing programs are needed in order to install the SVG Viewer plug-in.If the users do not have such rights to their computers, then administrators must configure the SVG



Viewer for each user separately.

If no other compatible SVG viewer is installed on the user's machine and an automatic installation ofthe Adobe SVG Viewer is disabled, then the Scorecard View will not be visible to the user.

NOTE: The Adobe SVG Viewer can also be installed manually from Adobe's web site: http://www.adobe.com/svg/viewer/install/

8.2.2 Support for Multiple QPR Web Application Servers

Each QPR Web Application Server installation must have its own folders for cgi-binaries and graphicsfiles. This can usually be done either by mapping directories directly to installation directories (whichcan be located anywhere) or by installing the Web Application Server's cgi-binaries and graphics filesinto folders, which are under folders that is accessible in the web.

8.2.3 Error Message Customization

The error messages related to the use of QPR WAS can be customized to suit the user's or theorganization's needs. To do this, edit the qprsettings.dat file, which is stored in the CGI-binaryinstallation directory. See Appendix D for information about settings available in qprsettings.dat. Someerror messages are also customizable by editing the [WAS Messages] section of the qpr.ini file,which is described in Appendix A.

Note that when using qpr.dll with Microsoft IIS, restarting only QPR Web Application Server is notsufficient to get qprsettings.dat changes into use, but you also need to restart IIS e.g. by runningiisreset.

http://www.adobe.com/svg/viewer/install/

http://www.adobe.com/svg/viewer/install/

User Management & Security


9 User Management & Security

This chapter provides information about configuring and using the QPR User Management Server andusing the different user authentication methods supported by the QPR User Management System.

9.1 Logging into the User Management System

Normally a user logs into the User Management System by using his or her UMS username andpassword. However, if NT/LDAP authentication is enabled for the User Management Server, then NT/LDAP usernames and passwords can be used as well.

In the case when there are not any users defined or you wish to log in as a system administrator, youhave to enter only the User Management System server password into the password field. Theusername field can be left blank in this case.

9.2 User Rights for the User Management Client

You can define the users who have access to the User Management Client. This is done by modifyingthe users' properties in the User Management Client. To grant a user access to the User ManagementClient, enable the Development Client option for QPR User Management and set the correct accessrights for that option. There are three alternatives:

View, meaning that the user can only view (i.e. not modify) the information in the UserManagement Client. Update, meaning that the user can do anything except remove users or groups.Administrate, meaning full rights. Note that if you log in as a system administrator, you aregranted administrator rights automatically.

9.3 Defining Users and Groups

Users and User Groups can be defined in the QPR User Management Client.

User groups are especially useful tools when administering the users of the system. User groups allowyou to easily set product rights for many users at once. Therefore you can grant product rights to onegroup that contains hundreds of users, rather than assigning the product rights to each of the usersindividually.

See the QPR User Management System User's Guide for more information about adding, modifying,and deleting users and user groups.



9.4 NT & LDAP User & Group Import

The NT and LDAP import functions can both be accessed from the QPR User Management client.

Both NT and LDAP User Import options are enabled in the QPR User Management Client only if theyhave been enabled as authentication methods in the QPR Configuration Manager utility.

See the QPR User Management System User's Guide for information about how to perform theimports.

9.5 Authentication Methods

The QPR User Management System can only be used for user authentication to QPR Products. Productspecific authorization information, i.e. user rights, is available from within each QPR product itself.

The QPR User Management System has three possible authentication methods: QPR, NT, and LDAP.

If either one of the NT or LDAP authentication methods is used then users are authenticated againstthe user id/password combination in the NT domain/LDAP server.

For example scenarios about using the different group management methods, refer to chapter NT &LDAP Authentication.

9.5.1 NT & LDAP Authentication

Unless the User Management Server is installed as a service on a system account, one last step isrequired to configure the NT authentication method. The user account you are using to run QPRService must have "Act as part of operating system" local security policy rights on the computer wherethe service is executed. Otherwise it is not possible to use NT authentication in the User ManagementSystem.

Note that currently a secure LDAP authentication requiring a client certificate is not supported.However, it is still possible to secure the connection to the LDAP server using SSL.

9.5.1.1 With Synchronized NT/LDAP Group Management

This chapter describes the steps required for using the synchronized NT/LDAP group managementmethod.

1. Enable the NT/LDAP authentication by selecting the Windows NT and/or LDAP options in the"Authentication method" sub-section of the QPR User Mgmt Server / General section in the QPRConfiguration Manager.

2.Either: In the User Management Client, create a new group that has the same name as that inthe NT domain/LDAP server and to which you would like to grant access to a QPR product. Or: Create a group that will be a default user group for users imported from the NT domain orthe LDAP server. There is no need to have a similarly named group in the NT domain/LDAP



server. Open the QPR Configuration Manager utility

Go to the QPR User Mgmt Server / General sectionSelect "Synchronized with NT/LDAP" in the "User Group" sub-section.

In the same sub-section, insert the new group's name into the Default User Groupfield.

3. For this group, select the appropriate access rights settings for each QPR product.

If the new group is named after an existing NT/LDAP group, the users of a corresponding groupwithin the NT domain/LDAP server have access rights to those QPR products for which access wasgranted to in step 3. If there is no corresponding group and the Default User Group setting has beendefined, all new users will be added to the Default User Group when:

Their login to a QPR product is successful (this requires that the default user group has rights tothat product).They do not belong to an NT/LDAP group that exists in the User Management System and hasrights to QPR products.

For users who belong to groups that have a similar name in both the NT domain/LDAP server andQPR UMS, the administrator can easily deny a user's access to the QPR product by simply removingthe user from the group in NT domain/LDAP server. To do this, no modifications need to be madefrom within the QPR User Management System. Users' rights are defined by the rights of the groupthe user is part of in the QPR User Management System. However, users in the default user group arenever removed automatically, so those users must be removed manually from UMS.

With LDAP you can also use synchronization between UMS and LDAP so that groups are kept in syncautomatically. This means that whenever a user is added to LDAP to a group which exists also in QPRUMS, the user is added to QPR UMS during the next synchronization run without the user having tolog into QPR products. In addition, updates to user details (full name, e-mail, telephone number, anddescription) done at LDAP are synchronized to QPR UMS during the next synchronization in the casethe user exists in a similarly named group in both LDAP and QPR UMS. See the [UMS Settings] sectionin Appendix A for more details about the necessary configuration.

NOTE If the Synchronized NT/LDAP Group Management is used, then the user is automatically eithercreated or transferred to the UMS group under the same name as the user's NT/LDAP group or to thedefault user group when the user logs into some QPR product.

9.5.1.2 With "UMS only" Group Management

This chapter describes the steps required for setting the authentication method to either the NT orLDAP authentication method.

1. Create a group to UMS (Note that the same group does not have to exist in NT/LDAP). 2. For this group, select the appropriate access rights settings for each QPR product.3. Next you must enable NT/LDAP authentication by selecting the Windows NT and/or LDAP options inthe "Authentication method" sub-section of the QPR User Mgmt Server / General section in the QPRConfiguration Manager.4. Restart UMS Server if it was running while you were changing settings

You can also define a default user group to UMS for Windows NT/LDAP users. By using this option it'spossible to authenticate users easily, using product permissions defined to the default user group inUMS.

A group can be made the default group in the following way:



Open the QPR Configuration Manager utilityGo to the QPR User Mgmt Server / General section.Select "UMS Only" in the "User Group" sub-sectionInsert the new group's name into the Default User Group field.p

If the default group is used, users are created into the default group when the followingpreconditions are met: 1. User does not exist in UMS

- NT/LDAP login is successful - The default group has enough rights to the product the user is logging into

2. User exists in UMS - NT/LDAP login is successful- User uses group rights- User does not belong to any group

Note: Users can be members of multiple UMS groups:You can define only one default group for all usersUser rights override group rightsStronger group rights override weaker group rights

9.5.2 Using Single Sign-On with QPR Products

It is possible to use single sign-on authentication with QPR products. QPR Portal, QPR Web ServicesFoundation, QPR ProcessGuide Designer, and QPR ScoreCard Designer support the use of IntegratedWindows Authentication (IWA) for login. In addition, generic single sign on (SSO) is available for QPRPortal. With QPR Portal only Microsoft Internet Information Services (IIS) is supported as a webserver. See the instructions below for information on enabling single sign-on authentication:

Changes in QPR Configuration Manager

1. Change the following settings in the General tab of the QPR User Mgmt Server section:

Select the authentication method(s) you want to use in the "Authentication method" sub-section. ForSingle Sign-On to work, you need to have Windows NT and/or LDAP selected. In the case you aregoing to use Intergrated Windows Authentication with LDAP authentication, make sure ActiveDirectory is set as the naming convention for LDAP (this can be done in the LDAP Settings sub-section). Check also that cookies are not used for autologin, i.e. the "Do not use cookies for autologin"option is selected in the "Autologin settings" sub-section. Select also the desired group managementmethod from the "User group" section. See the previous two chapters for more information about theuser group management methods.



2. Change the following settings in the Single Sign On sub-section of the QPR User Mgmt Serversection:

Select the products for which you want to enable Integrated Windows Authentication (IWA) or genericSingle Sign On (SSO) by checking the desired checkboxes. In the case you selected QPR Portal ineither section, define also the IP address of the server computer containing QPR.exe/QPR.dll into theCGI binary IP field in the General Settings section.



The Single Sign On (SSO) option enables you to use single sign on in trusted environments where aweb request's header variable carries the login name of the authenticated user. In the case yourportal environment supports setting header variables for authenticated users, you can utilize thegeneric single sign on support for authenticating to QPR Portal. This functionality enables integrationfor example with the SAP Logon Ticket system.

Using the SSO option requires also that qprsettings.dat in the CGI binary/ISAPI DLL folder (C:\Inetpub\wwwroot\qpr81\Portal by default) is modified to define the name of the header variablecontaining the login name. Add a HDR_VAR_USR = <variable name> setting to the file.

Check log on account for QPR service

3. Make sure that QPR Service 8.1 is run with an account that can make queries to Active Directory.

Restart QPR service

4. Start/restart QPR service so that changes take effect.

Check Microsoft Internet Information Services (IIS) settings

5. The following applies regardless of IIS version:Anonymous access needs to be disabled and Windows Authentication enabled on the QPR81application / virtual directory and Portal virtual directory

On IIS 7 and newer, also make sure that the Windows Authentication feature is installed on IIS.



9.6 LDAP Configuration Settings

In addition to the settings available in the QPR Configuration Manager utility, setup information canbe modified in the "qpr.ini" file (in the common profile folder - see Appendix A for details). For generalinformation about LDAP and LDAP settings in the QPR Configuration utility, see chapter LDAPConfiguration Settings in "qpr.ini" File.

The following abbreviations are used throughout this chapter:CN: The Common Name attribute of an LDAP entry.DN: Distinguished name of an LDAP entry.LDAP: Lightweight Directory Access ProtocolUID: The user ID attribute of Domino's LDAP person entries.

9.6.1 LDAP Configuration Settings in "qpr.ini" File

The ini file contains a section called UMS LDAP. The section has the following keys:Username: the DN of the person entry used if the LDAP component logs in to the LDAP serverwith a username/password combination. If left blank, an anonymous login is used.Password: the userPassword attribute of the person entry used if the LDAP component logs in tothe LDAP server with a username/password combination. Leave this blank if an anonymous login



is used. The user password is stored encrypted.Searchbase: the DN of the entry under which the search is performed on. If left blank, the searchstarts from the top entry.ServerAddress: the address of the LDAP server. This must be specified.AlwaysUseSecureConnection: If this is 0, then an insecure connection is used between the LDAPcomponent and LDAP server for all other functions than Authenticate.AuthenticateViaSecureConnection: If both this and AlwaysUseSecureConnection are 0, thenAuthentication is done with insecure connection. If AlwaysUseSecureConnection is 1, then thissetting has no effect (i.e. then it automatically defaults to 1).AllowConcurrentCalls: If this is 1, LDAP calls can be performed concurrently instead of beingserialized.ActiveSettingGroup: Identification of the currently active setting group. Each setting groupcontains technical settings to be adjusted to the LDAP directory used. The setting group namesare enumerated in an ini file section called LDAPSettingGroups. In that section, for each settinggroup identification there is the name of the section containing the settings for that settinggroup. See Example below. See Appendix A for more details about LDAP settings groups.

An example LDAP configuration file:

[UMS LDAP]UIDAttrName=uidUsername=CN=Testi Henkilo,OU=Oulu,O=QPRPassword=qprqprSearchbase=ServerAddress=10.0.12.10AlwaysUseSecureConnection=0AuthenticateViaSecureConnection=1 ActiveSettingGroup=1AllowConcurrentCalls=0

[UMS LDAP Setting Groups]1=Standard2=Active Directory

[UMS LDAP Standard]DistinguishedNameAttribute=dnCommonNameAttribute=cnEmailAttribute=mailMemberAttribute=memberDescriptionAttribute=descriptionPersonFullNameAttribute=<default>FilterForSearchingGroups=(|(objectclass=groupOfNames)(objectclass=group))FilterForSearchingPersons=objectclass=personUIDAttributeName=uidUseADGlobalCatalog=0

[UMS LDAP Active Directory]DistinguishedNameAttribute=dnCommonNameAttribute=cnEmailAttribute=mailMemberAttribute=memberDescriptionAttribute=descriptionPersonFullNameAttribute=<default>FilterForSearchingGroups=objectclass=groupFilterForSearchingPersons=objectclass=personUIDAttributeName=cnUseADGlobalCatalog=1



9.6.2 Steps for Creating a New LDAP Setup

1. Open the configuration file "qpr.ini" for editing - see Appendix A for details about where the file islocated.

2. Add a new section to the ini file. Give it a name which describes the new setup that you arecreating. The format is [UMS LDAP <name of your settings>], for example "[UMS LDAP MySettings]".

3. Copy the settings from some other existing setup sections.4. Edit the copied settings so that they correspond to the requirements of your LDAP system. After

editing the new section should contain these items:[UMS LDAP My Settings]DistinguishedNameAttribute=dnCommonNameAttribute=<The full name attribute of your LDAP directory>EmailAttribute=<The email attribute of your LDAP directory>MemberAttribute=<The member attribute of your LDAP directory>DescriptionAttribute=<The description attribute of your LDAP directory>PersonFullNameAttribute=<The full name attribute of the user; refers to CommonNameAttribute if not defined explicitly>FilterForSearchingGroups=<The search filter for retrieving groups>FilterForSearchingPersons=<The search filter for retrieving persons>UIDAttributeName=<The login name attribute of your LDAP directory>

5. In the UMS LDAP Setting Groups section, add a new line, which identifies your new setup, afterthe last item of the section:

[UMS LDAP Setting Groups]1=Standard2=Active Directory3=My Settings

NOTE Add the name of your new setup under "UMS LDAP Setting Groups" section in ini-file. Add itas the last item of the section. Do not insert the name into some other location. The name ofthe new setup must be exactly the same as the name of the settings section. Use consecutivenumbering, when entering the index for the new setup name. If the previous index was 2 (asin the example), then set the index to 3, when adding the new setup name.

6. Save the ini-file. If the QPR Configuration Manager utility is open, restart it. The new settingsgroup is now added and should be selectable in the configuration utility.

9.6.3 Example of Configuring Connection to Windows Active Directory LDAP

Before starting configuration, you should check that the Windows Active Directory LDAP in your serveris activated. Verify also that the user name you are going to use to connect to LDAP server has beengranted at least read rights to the user information.

This example is going to use the following setup information:Common name for user information branch in LDAP = usersUser name = qprPassword = demoDomain name = testdomainOrganization = qprLocation = fiLDAP Server IP Address = 127.0.0.1No secure connectionLogin using predefined account

The configuration information should appear in the QPR Configuration Manager utility as shown in thefollowing picture:



Example LDAP settings configured for connection to Windows Active Directory LDAP

NOTE If the Windows server that you are using is using some other language than English, then theparameter names, like the distinguished name for user information branch, may be different.Also depending of how the LDAP is set up, the number of required parameters and theparameter names may vary. This example describes the basic setup in Windows operatingsystem using the English language.

9.6.4 Example of Configuring Connection to Lotus Domino Directory

Configuring the connection to Lotus Domino Directory is done in a similar manner as with aconnection to the Windows Active Directory LDAP, which was illustrated in an example in the previouschapter. In most Domino configurations, however, the "search base" field can be set to be empty.This means that the searches for users and groups start from the top of the LDAP directory hierarchy.

The LDAP service must be set on in the Domino server. Either the anonymous access must beenabled, or there must be a person entry in the Domino directory, which has view rights to the usersand groups that need to be accessed. In the latter case, the distinguished name (DN) and thepassword of that person entry must be written in the server configuration and the 'anonymousauthentication' checkbox must be unchecked.

Since the SSL Client authentication is not supported by UMS, this option should be switched off in theDomino if SSL is used.

This example is going to use the following setup information:



User name = UserNamePassword = demoOrganization = OrganizationNameLocation = fiLDAP Server IP Address = 127.0.0.1No secure connectionLogin using predefined account

The configuration information should appear in the QPR Configuration Manager utility as shown in thefollowing picture:

Example LDAP settings configured for connection to Lotus Domino Directory

NOTE If the Domino server that you are using is using some other language than English, then theparameter names, like the distinguished name for user information branch, may be different. Alsodepending of how the LDAP is set up, the number of required parameters and the parameter namesmay vary. This example describes the basic setup in Windows operating system using the Englishlanguage.

Web Publishing


10 Web Publishing

Information contained in QPR products can be easily communicated and utilized on the web. Thischapter provides you with information about the different web publishing options available in the QPR8 suite.

10.1 Dynamic Web Application Server

The most efficient and flexible way of publishing information from QPR products is to utilize QPRPortal, which runs on the QPR Web Application Server. QPR Portal combines information from QPRSoftware products (QPR ScoreCard and QPR ProcessGuide) into one portal view, which contains therelevant information customized for each individual user's needs.

QPR Portal provides you with a view of your QPR Management Software information that is:always up-to-date meaningful and related to your responsibilities customizable according to your preferenceseasily navigatable and searchable

QPR Portal offers a generic tabbed web view, allowing a simple way to find and view the specificinformation that users need. It can be used to browse information published in both QPRProcessGuide and QPR ScoreCard.

10.2 Static Web Publishing

In addition to using dynamic web publishing with QPR Web Application Server, you can create staticweb pages of your QPR ProcessGuide and QPR ScoreCard models. See the subsections of this chapterfor more information.

10.2.1 Static Web Publishing with QPR ProcessGuide

For small-scale web publishing purposes, QPR ProcessGuide can generate web pages of the processmodel with the Web Page Export tool. See QPR ProcessGuide User's Guide for information about usingthe Web Page Export tool and QPR Developer's Guide for information about customizing the layout ofthe generated web pages.

10.2.2 Static Web Publishing with QPR ScoreCard

In addition to using the dynamic QPR ScoreCard Web Client in the QPR Portal, it is possible to createstatic web pages of certain views that you want to make available without the need for QPR Portalaccess and identification. An example of using static web publishing can be communicating thequarterly (i.e. the pages do not have to be updated too often) results to the whole organization. Forinformation about creating static QPR ScoreCard web pages, refer to QPR Developer's Guide.

Maintenance


11 Maintenance

This chapter defines the different maintenance routines that need to be done by the QPRadministrator. This chapter does not cover standard database maintenance tasks like backup issues.The maintenance need depends on the phase of the QPR suite implementation inside theorganization. This chapter assumes three different phases. Here are some characteristics of thedifferent phases:

Startup phase - The system is just taken into use. Mainly modelers are learning to use thesystem. Possibly heavy transactions from training usage and test web usage.

Modeling phase - Organization starts to implement the scorecard. Some web usage.

Steady phase - The measurement model is ready. Usage contains mainly measuring andreporting. Transactions from heavy web usage and data imports.

When the log file is checked, it is recommended to make a backup of it and remove it from the logfolder. QPR applications can be configured not to restrict the growth of the log file, so taking backupcopies helps administration as you do not have to handle text files of very large size.

If severe system errors occur, the system writes a vast amount of debug information into acorresponding log file. This information contain the internal state of the system at the time of theerror helping QPR to pinpoint the problem. This information cannot be used by users to sort out theproblem, but it should be communicated to QPR Customer Care instead. The debug informationappears in the following format:

<Time> <Date> <Product/Component> <Type (Information/Error/Notification)> <Thread id> <Message>

where <time> has the format 'hh:nn:ss zzz'

Below is a sample from a log file:

15:02:35 3504 02/07/08 UMS Information ID:3108 QPR User Management Serverstarted, version 8.0.9.116

11.1 Modeling Phase Routines

11.1.1 Daily Routines

No daily routines.

11.1.2 Weekly Routines

Check log files for possible program failures. When the log file is checked, it is recommended to makea backup of it and remove it from the <path to All Users profile>\Application Data\QPRSoftware\QPR 8\8.1\Logs (C:\ProgramData\QPR Software\QPR 8\8.1\Logs in Windows Vista and laterversions) directory, especially if the log file is quite large.

Maintenance


Check available table and transaction log space and increase if needed.

11.1.3 Monthly Routines

No monthly routines.

11.2 Steady Phase Routines


No daily routines.


If weekly periods are used for data imports, check the SCSSchedulerLog.txt located in <path to AllUsers profile>\Application Data\QPR Software\QPR 8\8.1\Logs (C:\ProgramData\QPR Software\QPR 8\8.1\Logs in Windows Vista and later versions) by default, for possible failures on imports.


Check log files for possible program failures. When the log file is checked, it is recommended to makea backup of it and remove it from the <path to All Users profile>\Application Data\QPRSoftware\QPR 8\8.1\Logs (C:\ProgramData\QPR Software\QPR 8\8.1\Logs in Windows Vista and laterversions) directory, especially if the log file is quite large.

Check SCSSchedulerLog.txt for possible data import failures.

Check available table and transaction log space and increase if needed.

11.2.4 Quarterly Routines

Check available software updates from QPR.

Maintenance


11.3 Startup Phase Routines


Check log files for possible program failures.


No weekly routines.


No monthly routines.

11.4 Notes & Limitations

Archived Models

Large models require a considerable amount of memory for QPR ScoreCard Application Server andQPR Web Application Server machines. To reduce memory consumption, large models can bearchived through the Model Properties settings of the QPR ScoreCard.

The QPR Web Application Server will not load archived models into the main memory and thus thosemodels are not available on the QPR Portal. However, opening an archived model with QPR ScoreCardDevelopment Client is possible. When the model is opened, QPR ScoreCard Application server willread it into the RAM and when it is closed, the allocated memory will be freed, which is not the casewith regular models.

Inter-model references to elements of an archived model cannot be created and any existingreferences cannot be refreshed until archiving is switched off. Furthermore, all scheduled tasks for anarchived model are suspended.

Configuration Utilities

At the moment the QPR Configuration Manager cannot cope with the Far East double-byte charactersas an input. Therefore it is important that only ISO 8859-1 (Latin-1) characters will be used with theinput fields. To avoid problems, make sure that all QPR components will be installed along a path,which does not contain any double-byte characters.

Localization

Options such as Category, Status and Severity options in different actions in the QPR Portal are notpart of the localization. Therefore option strings are always in English regardless of the Portal'slanguage setting. For information about customizing these options, see the Customizing Action Types

Maintenance


for QPR Portal chapter under the Customizing QPR Portal chapter in QPR Developer's Guide.

11.5 Troubleshooting

The following is a list of frequently asked questions and commonly encountered problems. Rememberto first check your log files when you encounter problems, because most errors are reported to the logfiles. If you cannot find the answer to your problem in this chapter, contact QPR Customer Care.

Q: What is the cause of the error "Connection was not opened"?

A: In most cases, the cause of this problem is one of the following:The corresponding server component is not runningThe configuration has a wrong IP address or hostname.The configuration has a wrong Port

In the unusual case that the cause is not one of the three stated above, you should contact the QPRCustomer Support.

Q: Why won't my QPR server component start?

A: In most cases, the cause of this problem is one of the following:The data source is undefined or incorrectThe version of the database is incorrect (e.g. using QPR 7.6 database)The communication port is busy (in use by another program)QPR User Management Server is not running.

However, in the case the disfunctional server component is QPR User Management Serveritself, the problem is most likely a misconfigured data source.

There are more users for the product in QPR UMS than the current activation status allows.Check the UMS log for activation-related error messages. For example, QPR ProcessGuide andQPR ScoreCard Servers won't start if there are more users than activations.

Information about the cause can be found in the corresponding server component's log file.

Sometimes clearing the cache of the server helps as well. You can locate the cached content under<path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\Cache (C:\ProgramData\QPRSoftware\QPR 8\8.1\Cache in Windows Vista and later versions). Before emptying the cache, makesure that any QPR server components are not running.

Q: How do I import a file such as a text file or an Excel spreadsheet into QPR ScoreCard?

A: The method of importing a file is very similar to that of importing an SQL database.

First create a System DSN

You must first define a DSN (data source with the appropriate driver) in the ODBC Data SourceAdministration, which can be accessed from your Control Panel. If you are administrating QPRScoreCard, you should define your DSN as a System DSN rather than a User DSN so that otherusers can access it as well.

Open the SQL Import window and follow the same method of importing a SQL database. However, toimport an excel spreadsheet, the SQL query must be in the form: select * from "excelsheet$" (NOTE:to specify an Excel spreadsheet as a database table, you must use the "……$" format). The SQL

Maintenance


import function interprets each sheet of an Excel workbook as one table. To import from the datasource which uses text files, the SQL query is as follows: select * from textfile.txt (NOTE: In this casetextfile.txt represents one database table).

Q: ScoreCard Server is consuming massive amounts of memory

A: One remedy for the memory consumption is lowering the value of DeletedObjectsTimeout in theSCS Scheduler section of the qpr.ini file. However, the value should always be several minutes toavoid errors (the values are in seconds, so 1200 means 20 minutes), but a too long time can increasethe memory consumption drastically.

Q: ProcessGuide Server is slow when there are large embedded information items

A: One possible solution for this problem is defining a threshold for an embedded information item'ssize. In the case the threshold is exceeded, the information item is stored on disk instead of inmemory. The settings can be defined in QPR Configuration Manager's QPR ProcessGuide Server ->Cache tab. Click the Help button on the tab to get more information about the settings.

Q: My e-mail notifications are not sent?

A: There might be couple of reasons for this. One could be that you have not defined SMTP serverand a reply address in the QPR Configuration Manager's E-mail tab. Another reason could be that yourSMTP-server is not functioning properly or that the users do not have valid e-mail addresses in theUser Management System. Check whether your SMTP server is using the default SMTP port (25).Check also that there is nothing but the server's location (for example smtp.yourserviceprovider.com).Yet another reason could be that the recipient that did not receive the e-mail did not have sufficientrights to the relevant Element (i.e. the one which contains the alerted value). Users must have atleast "View" rights to an Element to receive an alert about that Element.

Q: Some Portal buttons just show the "Page cannot be displayed" error message. What'sthe problem here?

A: Some buttons (e.g. Add to Basket and Actions) do not work properly if the Script location settinghas not been configured properly in the QPR Configuration Manager utility. The setting is located inthe Web Application Server -> Web Content section. The value should be a complete URL for the CGI-binary file (qpr.exe on servers running on Windows platform, qpr.cgi on others), for example http://server.company.com/cgi-bin/qpr.exe.

Q: I'm using Apache and my action headers with characters specific to my language arenot displayed correctly. What to do?

A: Open Apache's httpd.conf file (located under conf directory in your Apache installation directory)and search for AddDefaultCharset setting. Change the value of the charset (ISO-8859-1 by default) toa charset that supports your language. For example, with Turkish characters the line would look like"AddDefaultCharset ISO-8859-9" (without the quotation marks).

Q: My QPR Web Application Server is running as a service, and in the case it crashes, itnever gets back up again. The log is full of restart attempts.

A: This is most likely due to service startup times being too small, so the start attempt is terminatedbefore it has finished. To raise the times, launch the QPR Configuration Manager utility, open the

Maintenance


Common -> NT Service section, and try for example the following values:Startup time: 20 minutesCheck status every X minutes: 20 minutesResponse timeout: 10 minutes

Q: QPR Portal does not work and IIS gives error message "Unexpected Error 0x8ffe2740"during startup.

A: This can be due to some other program reserving port 80. For example Skype is set by default touse ports 80 and 443 in the case the port specified during installation is reserved. This can be avoidedby disabling the "Use port 80 and 443 as alternatives for incoming connections" option in Skype'sconfiguration or changing your web server to use a different port (not recommended as all URLswould have to be updated as well). See http://support.microsoft.com/default.aspx?scid=kb;en-us;816944 for more information.

Q: I have a linked Information Item document residing on a network drive, and I can openit with Microsoft Internet Explorer but not with Mozilla Firefox. How could I get them bothto work?

A: Mozilla Firefox does not support all Windows path types and therefore linked files do notsometimes open correctly in Portal. It is advisable to put all shared documents into a folder on a webserver and use regular hyperlinks (i.e. http://www.company.com/path/to/document.doc) instead ofWindows paths.

Q: I'm getting Response Processing Failed errors on QPR Portal even though theconfiguration appears to be valid.

A: On some setups port numbers larger than 8191 are restricted, and as the QPR Web ApplicationServer uses port 9000 as the default, the port number may need to be lowered. Please note that inaddition to changing the QPR Web Application Server port using the QPR Configuration Manager, youwill have to reflect the same change in the qprsettings.dat file (see Appendix D). With Microsoft IIS,you also need to run iisreset after the change to get the updated qprsettings.dat information into use.

Q: I'm trying to run QPR scripts, but I keep getting "ActiveX component can't createobject: 'SCClient.SCApplication'" and/or "ActiveX component can't create object:'PGClient.PGApplication'" errors. How can I solve this?

A: This is caused by missing or broken COM server registration for QPR ScoreCard Designer and/orQPR ProcessGuide Designer. To fix the registration, do the following:1. Launch command prompt with administrative privileges2. Go to the installation folder for the affected Designer component (C:\Program Files\QPR 8.1

\ScoreCard or C:\Program Files\QPR 8.1\ProcessGuide by default)3. Launch the executable with the /regserver command line switch, i.e. proguide.exe /regserver for

ProcessGuide or scclient.exe /regserver for ScoreCard.

Appendices


12 Appendices

12.1 Appendix A: Common QPR ini-file (qpr.ini)

This chapter describes the contents of the qpr.ini settings file. The sections are listed in alphabeticalorder.

The qpr.ini file can be found in three different locations in a regular installation:qpr.ini located in the QPR 8 installation folder (C:\Program Files\QPR 8 by default) contains onlycertain read-only settings. This is used only in the case the file in the All Users profile cannot befound. This file is read-only, so for instance QPR Configuration Manager does not modify this one.qpr.ini located in the <path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\Settings\<possible instance folder> folder (C:\ProgramData\QPR Software\QPR 8\8.1\Settings\<possible instance folder> in Windows Vista and later versions). This is used for system-wide configuration settings and for instance settings defined in QPR Configuration Manager areapplied to this file. In the case this file is missing, the qpr.ini located in the QPR 8 installation folderis copied here. If the files are missing from both folders, an empty qpr.ini is created here and thedefault settings are used.qpr.ini located in the <path to user-specific profile>\Application Data\QPR Software\QPR 8\8.1\Settings\<possible instance folder> folder. This is used for user-specific settings.

Abbreviations used in the file:UMS = QPR User Management SystemSCS = QPR ScoreCard ServerSCC = QPR ScoreCard ClientPGS = QPR ProcessGuide ServerPGC = QPR ProcessGuide ClientWAS = QPR Web Application ServerWLT = QPR Product Activation WizardSCP = QPR ScoreCard Plugin (i.e. the Web Client)PGP = QPR ProcessGuide Plugin (i.e. the Web Client)

[PGC Activation] Section

Field Field Type Description

DefaultLicPath String Name and location (relative to the QPR root folder)of the file containing product activation information.

DefaultTSLicPath String Name and location (relative to the QPR root folder)of the file containing product activation informationfor Terminal Services.

DClientLicense Integer Defines whether a server or a client license isneeded. 0 = server, 1 = client. 1 in this case.

[PGC Flow Chart Print Settings] Section


BlackAndWhite Integer Flag indicating whether the flowchart is printed inblack and white. 0 = no, 1 = yes.

OrganizationsOnEveryPage Integer Flag indicating whether organization item headersare reprinted on each page. 0= no, 1 = yes.

CheckpointsOnEveryPage Integer Flag indicating whether checkpoint headers arereprinted on each page. 0= no, 1 = yes.

SeparateSettings Integer Flag indicating whether the first page uses aseparate settings. 0 = no, 1 = yes.

Appendices



FixedSize Integer Flag indicating whether the flow chart print is donein fixed size. 0 = no, 1 = yes.

FitToOnePage Integer Flag indicating whether the flow chart print is fittedto one page. 0 = no, 1 = yes.

FitToPages Integer Flag indicating whether the flow chart print is fittedto multiple pages. 0 = no, 1 = yes.

PrintSubprocesses Integer Flag indicating whether all the subprocess levels areprinted as well. 0 = no, 1 = yes.

LeftMarigin Decimal Left margin used in flow chart print.

RightMarigin Decimal Right margin used in flow chart print.

TopMarigin Decimal Top margin used in flow chart print.

BottomMarigin Decimal Bottom margin used in flow chart print.

ZoomTo Integer Value for fixed size used in flow chart print.

PagesHigh Integer Number of vertical pages used in flow chart print.

PagesWide Integer Number of horizontal pages used in flow chart print.

Orientation Integer Flag indicating default printer orientation. 0 =Landscape, 1 = Portrait.

Page1HeaderItems Integer Number of items in the header for first page.

Page1HeaderItem0..n Integer Index for item, 0 = name, 1 = version, 2 = printingtime, 3 = creation time, 4 = last save time, 5 =page number, 9 = status

Page1HeaderItemLocation0..n

Integer Location of item, 0 = left, 1 = center, 2= right

Page1HeaderItemFontName0..n

String Font name.

Page1HeaderItemFontSize0..n

Integer Font size.

Page1HeaderItemFontBold0..n

Integer Flag indicating whether the item is bolded. 0 = no,1 = yes.

Page1HeaderItemFontItalic0..n

Integer Flag indicating whether the item's is in italic. 0 =no, 1 = yes.

Page1HeaderItemFontUnderline0..n

Integer Flag indicating whether the item is underlined. 0 =no, 1 = yes.

Page1HeaderItemFontStrikeout0..n

Integer Flag indicating whether the item is struck out. 0 =no, 1 = yes.

Page1HeaderItemFontColor0..n

Integer Color number for the item

Page1HeaderItemFontCharSet0..n

String Character set for the page header item font.

PageNHeaderItems Integer Number of items in the header for other pages,integer. Contains the same values as the first page.

Page1FooterItems Integer Number of items in the footer for the first page,integer. Contains the same values as the header.

PageNFooterItems Integer Number of items in the footer for the other pages,integer. Contains the same values as the first page.

Appendices


[PGC Flow Chart Settings] Section


ShowHiearchy Integer Defines whether the process hierarchy and theProcess Browser are shown. 0 = no, 1 = yes.

HierarchyWidth Integer Defines the Process Browser's width (in percents) inrelation to the child window. Valid values are 1-50.

MinChartHeight Integer Defines the Process Browser's height (in percents)in relation to the child window. Valid values are 1-50.

[PGC Intro Dialog, SCC Intro Dialog] Sections


Version<version> Integer Defines whether the introduction dialog is shown forthis specific version. 0 = no, 1 = yes.

Show Integer Defines whether the introduction dialog is shown atstartup. 0 = no, 1 = yes.

[PGC Log] SectionSee UMS Log

[PGC Main Form] SectionSee SCS Main Form

[PGC PG Publishing] Section


TypePublishingData<1...N> Binary Settings for the details view of an element type. Donot modify this value.

[PGC Recent Models] Section


ModelName<0-3> String Names of the most recently used models.

ModelId<0-3> String IDs of the most recently used models. -1 with filemodels.

ForceExclusive<0-3> Integer Reserved for future use.

[PGC Settings] Section


ForceAutomaticConnect Integer Defines whether the connection to ProcessGuideServer is forced, i.e. Development Client cannot bestarted if Server is not available. 0 = no, 1 = yes.

AutomaticConnect String Defines whether the Server connection is openedautomatically when starting ProcessGuide. 0 = no, 1= yes.

CreateBackupFile Integer Flag indicating whether a backup file is createdwhen the model is saved. 0 = no, 1 = yes.

ShowStatusbar Integer Flag indicating whether the status bar is shown. 0 =no, 1 = yes.

CustomBackground Integer Defines whether a custom bitmap is used as mainwindow background. 0 = no, 1 = yes.

Appendices



BackgroundImage String The name of the custom background bitmap file.

ModelCheckLevel Integer Flag used in model validation. 0 = no, 1 = yes.

ShowCloseConfirm Integer Flag indicating whether the "Do you want to closethe model?" confirmation is asked. 0 = no, 1 = yes.

FileOpenTimeout Integer Defines the delay time (in milliseconds) beforeopening the model.

FileOpenCheckFile Integer Flag indicating whether it is verified that the fileactually exists before opening the file. 0 = no, 1 =yes.

FileOpenChangeDir Integer Flag indicating whether the working directory ischanged to the directory where the file that is beingopened is located. 0 = no, 1 = yes.

DefaultTemplate String Name and location of the default file modeltemplate, if used.

ShowNewModel Integer Flag indicating whether the New Model dialog isshown when creating a file model. 0 = no, 1 = yes.

TasksDir String The name of the directory where predefinedintegration settings files are stored (if this ismissing, the application uses the default directory,which is <All Users profile>\Application Data\QPRSoftware\QPR 8\8.1\ PGIntegrationTasks, C:\ProgramData\QPR Software\QPR 8\8.1\PGIntegrationTasks in Windows Vista and laterversions).

GraphFont String The font used in Analysis and Simulation graphviews. If this setting is not defined, Arial is used bydefault. This setting can be used to correct fontproblems in some environments such as Thai,where for instance MS Sans Serif works fine.

GraphFontSize Integer Size of the graph fonts.

GraphFontSizeTitle Integer Size of the fonts used in graph titles.

SheetFont String The font used in different sheet views (Analysis andReport views, Process Step, Flow, and Groupdialogs). If this setting is not defined, Arial is usedby default. This setting can be used to correct fontproblems in some environments such as Thai,where for instance MS Sans Serif works fine.

SheetFontSize Integer Size of the sheet fonts.

ShowSimultaneousEditWarning

Integer Defines whether a warning about the model havingchanged due to simultaneous editing is displayed.In the case the warning is not displayed, thechanges are merged in the background and onlypossible conflict situations are shown, otherwise amessage requesting the user to reopen the modelfrom the server is displayed. 1 = show warning, 0 =don't show the warning.

HorizontalAttributeList Integer Defines whether custom attribute types aredisplayed in the flow chart as a horizontal attributelist. This setting is useful for flow charts created in

Appendices



QPR 7.5 since the visualization mode has changedto vertical after that. 1 = show horizontal attributelist, 0 = show vertical attribute list (default). Notethat in contrast to the similarly named key in [PGPSettings] section, this is a user-specific key andtherefore this should reside in qpr.ini located in the<path to user-specific profile>\ApplicationData\QPR Software\QPR 8\8.1\Settings\ folder.

CanEmptyChangeLog Integer Defines whether the user is allowed to empty ordisable the change log in QPR ProcessGuideDevelopment Client. 1 = the user can empty anddisable the change log (default), 0 = the usercannot empty or disable the change log.

DefaultWorkDirectory String Defines the folder that is opened by default withOpen and Save As operations for models. Thissetting is used until the user uses some otherdirectory for a successful model operation. The newfolder will be the default folder for the rest of theDevelopment Client session. In the case this settingis empty, the pgmodels folder under <All Usersprofile>\Application Data\QPR Software\QPR 8\8.1(C:\ProgramData\QPR Software\QPR 8\8.1 folder inWindows Vista and later versions) is used bydefault.

DefaultScriptDirectory String Defines the folder that is opened by default whenthe Run command for scripts is used and populatesthe Run Script menu by scripts in the folder. Thissetting is used until the user uses some other folderfor opening a script successfully. The new folder willbe the default folder for the rest of theDevelopment Client session. In the case this settingis empty, the pgscripts folder under <All Usersprofile>\Application Data\QPR Software\QPR 8\8.1(C:\ProgramData\QPR Software\QPR 8\8.1 folder inWindows Vista and later versions) is used bydefault.

FixedFlowEndPoints Integer Defines whether flow end points are maintained orchanged in relation to the element when theelement is resized. 0 = relative end points (i.e.resizing the element moves also the flow endpoints) are used, 1 = fixed flow end points areused, i.e. the end points are not moved when theelement is resized. In the case this key is missing, 0is used by default.

SharePointSiteURLs String Defines the URL(s) of SharePoint site(s). If multiplesites are defined, the URLs need to be separatedwith semicolons. The default SharePoint site is thefirst one on the list. If this string is empty,SharePoint actions are disabled.

NoInfoIconForDefaultInfoItem

Integer Defines whether the information item icon is shownin the middle of an information flow, when only oneinformation item is linked to the flow. 0 = icon is

Appendices



shown (default), 1 = icon is not shown.

[PGC Simulation] Section


ActivationQueueSize Integer The size of the activation queue (maximum numberof simultaneous activations).

StartDateTime String Date of starting the simulation.

SimulationLength Float The length of the simulation.

SimulationSpeed Float The simulation speed.

SaveTimeInfo Integer Flag indicating whether the time information of thesimulation is stored in the cases. 0 = no, 1 = yes.

SaveCostInfo Integer Flag indicating whether the cost information of thesimulation is stored in the cases. 0 = no, 1 = yes.

UseFlowIcons Integer Flag indicating whether the flow transfer icons areused in animation. 0 = no, 1 = yes.

UpdateFrequency Integer Update frequency for flow chart animation. Validvalues are 1-20.

CreateFullReport Integer Flag indicating whether the full report is created. 0= no, 1 = yes.

FullReportFile String The location for the full report file.

CreateProcessStepReport Integer Flag indicating whether the process step report iscreated. 0 = no, 1 = yes.

ProcessStepReportFile String The location for the process step report file.

CreateFlowReport Integer Flag indicating whether the flow report is created. 0= no, 1 = yes.

FlowReportFile String The location for the flow report file.

CreateResourceReport Integer Flag indicating whether the resource report iscreated. 0 = no, 1 = yes.

ResourceReportFile String The location for the resource report file.

[PGC Web Link] Section


LastReport String The date and time of the last generation of the webpages.

[PGC XML Integration] Section


SettingsFile String The full path and the file name of the last selectedtask file in XML integration.

ExportFile String The full path and the file name of the last selectedexport file.

XSLTFile String The full path and the file name of the last selectedXSLT file.

[PGP Log] Section

Appendices


See UMS Log

[PGP Settings] Section


ModelsInMemory String A comma-separated list of model IDs of models thatare loaded to memory when QPR Web ApplicationServer is started. The list is maintained by QPR WebApplication Server and contains the models thatwere in memory when QPR Web Application Serverwas last shut down.

LoadModelsToMemory String A comma-separated list of model IDs of models thatare loaded to memory when QPR Web ApplicationServer is started. This setting is maintained onlymanually, and if the value is empty or missing, thelist is considered to be empty.

LoadAllModelsAtStartup Integer Defines whether all models are loaded into memorywhen QPR Web Application Server is started as wellas right after the model has changed. With differentoptions this setting either overrides or utilizes theModelsInMemory and LoadModelsToMemory keys.The options are as follows: 0 = No models are readinto memory at startup. 1 = All models are readinto memory at startup. 2 = Models listed in theModelsInMemory key are read into memory atstartup, 3= Models listed in theLoadModelsToMemory key are read into memory, 4= Models listed in ModelsInMemory ANDLoadModelsToMemory key are read into memory atstartup. For standalone installation the default valueis 1, but for other installations the default value is 4.

LoadModelsFromCacheFiles Integer Defines whether models in file cache are usedduring QPR Web Application Server startup in thecase the model exists in cache and it is up to date.If the model is not cached or it is not up to date,the model is read from the QPR ProcessGuideServer. 0 = no, 1 = yes.

HorizontalAttributeList Integer Defines whether custom attribute types aredisplayed in the flow chart as a horizontal attributelist. This setting is useful for flow charts created inQPR 7.5 since the visualization mode has changedto vertical after that. 1 = show horizontal attributelist, 0 = show vertical attribute list (default). Notethat in contrast to the similarly named key in [PGCSettings] section, this is a global key affecting allusers of the corresponding instance of QPR WebApplication Server, and therefore this should residein qpr.ini located in the <path to All Usersprofile>\Application Data\QPR Software\QPR 8\8.1\Settings\<possible instance folder> folder (C:\ProgramData\QPR Software\QPR 8\8.1\Settings\<possible instance folder> folder inWindows Vista and later versions).

NoInfoIconForDefaultInfoIte Integer Defines whether the information item icon is shown

Appendices



m in the middle of an information flow, when only oneinformation item is linked to the flow. 0 = icon isshown (default), 1 = icon is not shown.

[PGS Activation] Section





[PGS Communication] Section


ServerName String Hostname or the IP address of the QPRProcessGuide Server.

ServerPort Integer Socket port of the QPR ProcessGuide Server.

Connections String A semicolon-separated list of configured serverconnections. Each connection entry is a comma-separated list of the following values: Order numberin the list, flag indicating whether the connection isthe default connection (0/1), connection's name,server's host, and port.

UseEncryption Integer Defines whether encrypted communication is used.1 = yes, 0 = no.

[PGS Log] SectionSee UMS Log

[PGS Main Form] SectionSee SCS Main Form

[PGS Model] Section


DaysInCache Integer Defines the amount of days unused models arestored in cache memory before they are removed.

OnDisk Integer Defines whether embedded information itemsexceeding the size defined in the Threshold settingare cached on disk (1, true) or on memory (0,false). 1 = true, 0 = false.

Threshold Integer The maximum size for embedded information items(in kilobytes) that are stored in the memory. If thesize is exceeded, the attachments are stored in harddisk.

MaxMemoryUsage Integer Maximum memory usage in megabytes. Minimumvalue is 128, maximum is 3072. Note that this valuecan be exceeded temporarily.

Appendices



ClearDiskCacheAtStartup Integer Defines whether model cache on disk is cleared atstartup. In the case this is 0 (false), old cached filesare utilized in the case their contents are up todate, thus resulting in a faster startup. 0 = false(default), 1 = true.

LoadModelsAtStartup Integer Defines how models are loaded into the QPR WebApplication Server at startup.

0 = Base models and published models that do nothave an existing cache file are loaded fromdatabase and written to cache. After this modelsare dropped from the memory.

1 = Base models and published models that do nothave an existing cache file are loaded fromdatabase and written to cache. Models are droppedfrom the memory in the case the memory limit isexceeded.

2 = Base models that do not have an existing cachefile are loaded from database and written to cache.

3 = No models are loaded from the database.

[PGS Service] SectionSee UMS Service

[PGS Settings] Section


LastFolder Integer ID of the last folder that was opened in theApplication Server. Application Server uses thissetting to open the same folder the next time themodel selection dialog is opened.

AuditTrailTrace Integer Defines whether audit logging is enabled. 0 = no, 1= yes.

IWAEnable Integer Defines whether Integrated Windows Authentication(IWA) is enabled for QPR ProcessGuideDevelopment Client. 0 = false, 1 = true.

PortalUpdateMethod Integer Defines the update method between QPRProcessGuide Server and QPR Portal. 0 =Immediate, 1 = Scheduled. Default value is 0. Ifscheduling is used, PortalUpdateScheduleIntervalmust be defined. Scheduling applies to the followingmodel operations: Save (not Save As), Replace,Rename, and Move (to another folder). However, inthe case a new published model is created, modelsin Portal are updated at the moment the new modelis saved. This setting can be used for example toschedule model update operations to occur outsidethe peak hours in environments with large models.

PortalUpdateScheduleStartDate

Datetime (dd.MM.yyyy hh:

Defines the initial start time of the updatingbetween QPR ProcessGuide and QPR Portal if

Appendices



mm:ss) PortalUpdateMethod = 1. IfPortalUpdateScheduleStartDate is not defined, theserver start date/time is used.

PortalUpdateScheduleInterval

String (dd:hh:mm)

Defines the interval between the updating of QPRProcessGuide and QPR Portal starting from the timedefined in PortalUpdateScheduleStartDate. Only oneinterval is supported. The correct format for thissetting is a colon-separated list of days, hours andminutes. For example, ifPortalUpdateScheduleStartDate = 12.12.200801:30:00 and PortalUpdateScheduleInterval =01:00:00, the first update takes place on12.12.2008 01:30 and subsequent updates are doneevery day at 01:30.

[Plugins Log] SectionSee UMS Log

[Portal Default Views] Section


scorecards String The default view for the Scorecards tab.

actions String The default view for the Actions tab.

processes String The default view for the Processes tab.

mycontents String The default view for the My Contents tab.

[Portal Log] SectionSee UMS Log

[Portal Settings] Section


PwdChanging Integer Allow password changing in Portal. 0 = no, 1 = yes.

UseDefaultHomeView Integer Defines whether the default home view is used. 0 =custom, 1 = default.

CustomHomeURL String Defines the URL of the custom home view if thedefault view is not used.

AllowUsersToChangeHomeView

Integer Allow users to customize the view shown in mycontents/home. 0 = no, 1 = yes.

DefaultView String The tab that is selected by default when logginginto the Portal.

AllowUsersToChangeDefaultTab

Integer Allow users to customize the default tab selectedwhen user logs into the QPR Portal. 0 = no, 1 =yes.

AllowUsersToChangeDefaultPages

Integer Allow user to customize the default views openedwhen some tab has been selected.

CustomCategoryLabelText String If not empty, determines the text used as label forcategory attributes in actions.

ShowViewTitles Integer Defines whether the Portal windows display theview titles (e.g. Add Action) in the browserwindow's title bar. 0 = no, 1 = yes.

Appendices



PublicBookmarkPositioning Integer Defines whether public bookmarks are shown afteror before the user's own bookmarks. 0 = own -public, 1 = public - own.

DefaultActionType String Defines the default type of action. The default typeis the type that is initially selected in the actioneditor when creating a new action.

DefaultPublishTo String Defines the default option that is selected in the"Publish to" section when creating a new action.Possible values are: Users of linked elements, Meonly, Everyone, and Selected users.

DefaultNotifyViaEmail Integer Defines whether the "Notify via e-mail" option ischecked by default in the action editor. 0 = no, 1 =yes.

DefaultAttachmentType Integer Defines the default type of attachments in theattachment editor. 0 = linked attachments, 1 =embedded attachments.

EnableBookmarksForViewUsers

Integer Defines whether users with view rights only cancreate bookmarks in QPR Portal. 0 = disabled, 1 =enabled.

[QPR Custom Colors] Section


Color<A-P> String User-defined custom colors.

[QPR Database] Section


DBAlias String The database alias that is used by all QPR products.

DBLogin String QPR database's login information.

DBPassword String QPR database's password (encrypted).

ReconnectInterval Integer The amount of seconds to wait before trying to re-establish a broken database connection.

ReconnectRetryTimes Integer The amount of times the database connection istried to be restored.

MassOperationRecordCount Integer Defines the maximum amount of records that arestored with one SQL query. By default the value is20. All positive integers from 0 upwards are validvalues for this key. This setting can be used onlywith Microsoft SQL Server and Oracle databases.

MassOperationMaxBlobSize Integer Defines the maximum size of blob fields that arestored with mass database operations. By defaultthe value is 10000. All positive integers from 0upwards are valid values for this key. This settingcan be used only with Microsoft SQL Server andOracle databases.

TransactionQueueWarningTime

Integer Defines the time (in minutes) after which a warningmessage is inserted in the relevant log file(s). Thewarning is triggered in the case a transaction hasbeen in a QPR server component's transactionqueue longer than the value defined here. In the

Appendices



case no value has been provided or the key ismissing, 120 is used as the default value.

TransactionQueueMaxTime Integer Defines the time (in minutes) after which an errormessage is inserted in the relevant log file(s). Theerror is triggered in the case a transaction has beenin a QPR server component's transaction queuelonger than the value defined here. Other databaserequests receive an error message telling that thedatabase is overloaded until the transaction thattriggered the warning is processed. In the case novalue has been provided or the key is missing, 600is used as the default value.

TransactionQueueMaxTransactions

Integer Defines the maximum amount of transactions in thetransaction queue. The default value is 100, but thiscan be increased to allow very large modelingoperations to be done within a short time periodwith a slow database. The limit for the amount oftransactions is meant to restrict loss of data in casethe server is terminated before transactions havebeen committed to the database.

DBConnectionKeepAlive Integer This setting defines the interval (in minutes)between simple read operations that are performedto keep the database connection alive. This value is0 by default (keepalive operations are notperformed), but in the case you encounter problemswith servers losing database connection after acertain amount of idle time, use this key with avalue that's smaller than the idle time limit in yourdatabase.

[QPR E-Mail] Section


ReplyAddress String E-mail address that will be used as the replyaddress in e-mail notifications.

AdminAddress String Administrator's e-mail address. This address willreceive alerts and notifications about serverfunctionality.

SMTPServer String Name of the SMTP server used for sending the e-mail notifications.

SMTPServerPort Integer The SMTP server port number used for sending thee-mail notifications. The default port number is 25.

SMTPLogin String Login name for the SMTP server. Used in the caseSMTPAuthentication is 1.

SMTPPassword String Password for the SMTP server in an encryptedformat. Used in the case SMTPAuthentication is 1.

SMTPAuthentication Integer Defines whether SMTP server authentication isused. 0 = no, 1 = yes.

EMailAlertsEnabled Integer Defines whether e-mail alerts are enabled. 0 = no,1 = yes.

AlertCategories Integer Defines what kinds of events are alerted by e-mail.

Appendices



1 = System notifications, 2 = Critical errors, 3 =both.

EnableBase64Encoding Integer Defines whether Action notification e-mails are sentas Base64 encoded UTF-8. 0 = disabled (default), 1= enabled.

[QPR Fonts] Section


UIFontName String The font used in user interface controls of QPRProcessGuide and QPR ScoreCard DevelopmentClients. This setting is useful in the case the defaultfont for example does not support all symbols in thelanguage used in the model.

UIFontSize Integer Size of the UI font.

NavigatorFontName String Font used in all tree navigator controls in QPRScoreCard and QPR ProcessGuide DevelopmentClients. This setting is useful in the case the defaultfont for example does not support all symbols in thelanguage used in the model.

NavigatorFontSize Integer Size of the navigator font

IndicatorFontName String Font used in the indicator view in QPR ScoreCard.This setting is useful in the case the default font forexample does not support all symbols in thelanguage used in the model.

IndicatorFontSize Integer Size of the indicator font

ChartTitleFontName String Font used in the history chart title in QPRScoreCard. This setting is useful in the case thedefault font for example does not support allsymbols in the language used in the model.

ChartTitleFontSize Integer Size of the chart title font.

LegendFontName String Font used in the legend of the history chart view inQPR ScoreCard. This setting is useful in the casethe default font for example does not support allsymbols in the language used in the model.

LegendFontSize Integer Size of the legend font.

UnicodeFontName String The font used in Unicode user interface controls(currently only translation dialogs for multilingualmodeling) of QPR ProcessGuide.

UnicodeFontSize Integer Size of the Unicode font.

[QPR Log] Section


Folder String Defines the folder where all the logs are stored.

GeneralLogMode Integer If set, defines the logging mode for all products. 0= force normal trace mode, 1 = force full tracemode, 2 = custom mode

[QPR Recent Information Items] Section

Appendices



Location<0-9> String The location of an information item. The mostrecently typed location is the first and the othersare sorted by time.

[QPR Service] Section


ServiceInstalled Integer Defines whether service is installed. 1 = yes, 0 =no.

StartupTime Integer The maximum number of seconds to wait forstartup (control semaphore) before terminating theserver process.

StatusCheckInterval Integer Number of seconds to wait between successiveserver responsivity checks.

ResponseTimeoutInterval Integer Number of seconds to wait for server process torespond to the control message.

ServerKillTimeout Integer Number of seconds to wait for the server process toshut down (when the service is being shut down)before terminating the process (ifEnableForceKill=1).

EnableForceKill Integer Determines whether the server process can beterminated by force if it does not shut down inServerKillTimeout seconds after the shutdownmessage has been sent (0 = false, 1 = true).

ApplicationTitle String Defines the name that is displayed for theapplication in the service list.

MaximumNumberOfStarts Integer Defines how many times the service tries to start incase of critical error at startup.

ExternalName String Name of the service used in dialogs and other userinterface objects. Do not modify this value unlessinstructed to.

InternalName String Used for controlling the service. Do not modify thisvalue unless instructed to.

InternalBaseName String Used for controlling the service. Do not modify thisvalue unless instructed to.

[QPR Settings] Section


DefaultLanguage Integer Default language used by all QPR products.

DefaultSubLanguage Integer Default sublanguage used by all QPR products.Used for distinguishing between e.g. ChineseTraditional and Chinese Simplified, which both havethe same DefaultLanguage entry.

Standalone Integer Defines whether a standalone version is installed. 1= yes, 0 = no. This setting controls if thecorresponding server components are launchedwhen QPR ProcessGuide Designer or QPRScoreCard Designer is launched. This option doesnot affect QPR Web Application Server or QPR WebServices Foundation.

Appendices



PreviousLogin String The username of the last user who has logged intoQPR products.

PreviousDomain String The name of the last domain from which a user haslogged into QPR products.

ClientScriptSecurity Integer Defines how QPR Scripts can be executed. 0 =scripts are not allowed to run, 1 = in DevelopmentClients only, a confirmation is asked, 2 = inDevelopment Clients only, no confirmation, 3 =running scripts is allowed both in DevelopmentClients and in Windows Explorer, 4 = as with 3, inaddition Integrated Windows Authentication isallowed.

ScriptTimeOut Integer Defines the default timeout value for QPR scriptsthat do not contain the setting in the scriptsthemselves. The value is the interval (in seconds)for displaying a notification about a time-consumingscript being executed. Setting this to 0 disables thenotification.

ClientServerCompression Integer Defines whether compression is used in client -server communication. The possible values are: 0 =no compression is used except for model exports. 1= if network connection is slower than 10Mb/s,compression is used for packets larger than 512bytes. 2 = compression is always used for allpackets larger than 512 bytes. In the case this keyis missing or the value has not been defined, 1 isused by default. This setting is a client-side setting,i.e. the client computer defines the use ofcompression.

QueryResultExpirationTime Integer Defines the time (in minutes) for how long viewswith lots of list information (such as Analysis viewsand actions fields with lots of result rows) arecached. Updated information is guaranteed toappear in QPR Portal only after the time defined inthis key has passed after the update. Note thatlowering the caching time reduces performance.Setting this to 0 (default) disables the caching ofquery results.

QueryExpirationCheckInterval Integer Defines the maximum interval (in minutes) betweenchecking whether there are query results whichhave expired as a result of reaching the timedefined in QueryResultExpirationTime. If suchresults are found, they are dropped from thememory. The default value is 5.

CacheFolder String Defines the folder in which cache files created byQPR server components are stored.

ForceClearTypeFontSmoothing Integer Defines whether clear type font smoothing is usedin QPR ProcessGuide flow charts even if clear typefont smoothing has not been enabled in displaysettings, 0 = off (default), 1 = on.

Appendices


[SCC Activation] Section





[SCC Intro Dialog] SectionSee PG Intro Dialog

[SCC Log] SectionSee UMS Log

[SCC Main Form] SectionSee SCS Main Form

[SCC NavBar] Section


ShowLeftNavBar Integer Defines whether the left navigation bar is shown inthe Scorecard Explorer. 1 = yes, 0 = no.

ShowRightNavBar Integer Defines whether the right navigation bar is shown inthe Scorecard Explorer. 1 = yes, 0 = no.

ShowLeftShapeGroup Integer Defines whether the Shapes group is shown in theleft navigation bar. 1 = yes, 0 = no.

ShowRightShapeGroup Integer Defines whether the Shapes group is shown in theright navigation bar. 1 = yes, 0 = no. In the casethis setting is 1 and the ShowLeftShapeGroup is 1too, the Shapes group is shown in the leftnavigation bar.

ShowLeftElementGroup Integer Defines whether the Elements group is shown in theleft navigation bar. 1 = yes, 0 = no.

ShowRightElementGroup Integer Defines whether the Elements group is shown in theright navigation bar. 1 = yes, 0 = no. In the casethis setting is 1 and the ShowLeftElementGroup is 1too, the Elements group is shown in the leftnavigation bar.

ShowLeftScorecardGroup Integer Defines whether the Scorecards group is shown inthe left navigation bar. 1 = yes, 0 = no.

ShowRightsScorecardGroup Integer Defines whether the Scorecards group is shown inthe right navigation bar. 1 = yes, 0 = no. In thecase this setting is 1 and theShowLeftScorecardGroup is 1 too, the Scorecardsgroup is shown in the left navigation bar.

[SCC Settings] Section


DefaultReportFolder String Folder where reports are located.

DefaultReportWWWServer String URL where published reports will appear.

Appendices



DefaultWorkDirectory String Defines the folder that is opened by default withImport and Export operations for models. Thissetting is used until the user uses some otherdirectory for a successful import or exportoperation. The new folder will be the default folderfor the rest of the Development Client session.

DefaultScriptDirectory String Defines the folder that is opened by default whenthe Run command for scripts is used. This setting isused until the user uses some other folder foropening a script successfully. The new folder will bethe default folder for the rest of the DevelopmentClient session. In the case this setting is empty, thescscripts folder under <All Usersprofile>\Application Data\QPR Software\QPR 8\8.1(C:\ProgramData\QPR Software\QPR 8\8.1 folder inWindows Vista and later versions) is used by default.

EnableGDIPlusGraphs Integer Defines whether Microsoft Windows GDI+ is used indrawing charts. 1 = yes (default) 0 = no. Disablethis setting if you encounter troubles in drawingcharts.

[SCP Log] SectionSee UMS Log

[SCP Reports] Section


WebReportPath String Path where the published reports are stored.

WebReportURL String URL where the published reports are found.

ReportCommands Integer The amount of report commands

ReportCommand<0...N> String Report command's name

ReportCommandValue<0...N>

String Report command's value.

FileExtension String File extension for the report files.

WebReportCGI String Path for an external report viewing application.

UseCGI Integer Defines whether an external report application isused. 0 = no, 1 = yes.

RemoveExtraFiles Integer Defines whether extra files are removed from theweb file publishing directory at startup. 0 = no, 1 =yes

[SCP Settings] Section


Cache Integer Defines whether browser cache is in use. 0 = no, 1= yes.

MinRecent Integer Minimum amount of entries to show in the What'sNew page in Portal.

MaxRecent Integer Maximum amount of entries to show in the What'sNew page in Portal.

Appendices



RecentDays Integer The maximum amount of days included in theWhat's New page listing.

GraphicalViewerAutoInstall Integer Defines whether automatic SVG plugin installation isenabled. 0 = no, 1 = yes.

EnableGraphicalViews Integer Defines whether graphical Scorecard views areenabled. 0 = no, 1 = yes. The element graph layoutof the element view is also hidden when this is setto 0.

RemoveGeneratedGraphicsFiles

Integer Defines whether old *.svg files are removed atstartup. 0 = no, 1 = yes.

GraphicalViewer Integer Defines what SVG plugin is used. 0 = Adobe SVGViewer 3, 3 = Microsoft Silverlight plugin (default).

UseBufferedValueInput Integer Defines whether value input is allowed when themodel is reserved e.g. for recalculation. In the casebuffered input is allowed, values can be input whenthe model is reserved, but the new values arestored in a temporary buffer and applied to themodel once the reservation is freed. 0 = disabled(default), 1 = enabled.

WaitForValueUpdate Integer Defines the maximum amount of seconds to waitfor a buffered value update to finish in QPR Portal.Default is 6 seconds.

UseBitmapTextInGraphicalViews

Integer Defines whether SVG/Silverlight views display textas bitmap graphics instead of using text capabilitiesof SVG and Silverlight. This setting is useful e.g. insituations where some language-specific featuressuch as joining characters based on their contextdoesn't work properly. 0 = disabled (default), 1 =enabled. Note that if this setting is enabled, chartsin Element Views are always drawn as PNG images.

EnableGDIPlusBitmapGraphs

Integer Defines whether Microsoft Windows GDI+ is used indrawing charts if UseBitmapTextInGraphicalViews is1 or the charts have background pictures. 1 = yes(default) 0 = no. Disable this setting if youencounter troubles in drawing charts.

ScorecardHierarchyMode Integer Defines which scorecards are hidden in thescorecard hierarchy view in QPR Portal when a userdoesn't have enough rights. 0 = No scorecards arehidden (default), 1 = Scorecards for which the userhas no rights are hidden from the hierarchy, afterwhich the hierarchy is flattened, 2 = If a scorecardfor which the user has no rights doesn't have anychild scorecards or the user doesn't have rights forall of its children, that scorecard and its children arehidden from the hierarchy. All other scorecards arevisible, even if the user had no rights for them, 3 =Scorecards for which the user has no rights and allits children are hidden from the hierarchy, nomatter if the user had rights for some of thechildren, 4 = Scorecards for which the user has norights are hidden from the hierarchy and their

Appendices



children are attached under the deepest prevailingparent. If a user has no rights for the parents, thechildren are moved to the top level.

ScorecardNameMode Integer Defines how those scorecards for which the userhas no rights but still remain visible in the scorecardhierarchy in QPR Portal afterScorecardHierarchyMode is applied are handled. 0= The names of the scorecards for which the userhas no rights are shown, but the links are notclickable (default), 1 = The names of thescorecards for which the user has no rights are notshown. Instead, their names are displayed as"Access Denied".

EnableHyperlinksForTextValues

Integer Defines whether hyperlinks are createdautomatically in QPR Portal from URLs entered astext type measure values. 0 = Hyperlinks are notcreated automatically (default), 1 = Hyperlinks arecreated automatically.

[SCS Activation] Section





[SCS Calculation] Section


CalculationEnabledByDefault

Integer Defines whether calculation is enabled for modelsby default. In the case calculation is disabled,values can still be input, but formulas are notcalculated automatically. 0 = no, 1 = yes (default).

CalculationEnabledFor String A comma-separated list of names or IDs of modelsfor which calculation should be enabled in the casecalculation is disabled by default. Model names inthe list must be in double quotes, and in the caseany model name contains double quotes, thequotes inside the name must be preceded byanother double quotes. It is also advisable to putthe whole list inside double quotes to ensure thatthe quotes are parsed properly.

CalculationDisabledFor String A comma-separated list of names or IDs of modelsfor which calculation should be disabled in the casecalculation is enabled by default. Model names inthe list must be in double quotes, and in the caseany model name contains double quotes, thequotes inside the name must be preceded byanother double quotes. It is also advisable to put

Appendices



the whole list inside double quotes to ensure thatthe quotes are parsed properly.

CalculatorThreads Integer Defines how many threads are used for QPRScoreCard model calculation. If this value ischanged, calculations which are not dependent onthe results of other calculations are done in parallelin the defined amount of threads. The default valueis 0, and in this case computers with a singleprocessor use one thread for the calculation andcomputers with multiple processors use twothreads. In the case there are less than 100 valuesto calculate, only one thread is used regardless ofthis setting.

ModelRecalculationPeriodChunkSize

Integer Defines how many values (every single value underevery period and series in a measure counts as aseparate value) are included in one calculationtransaction during model recalculation. The defaultvalue is 1200000, and reducing this value consumesless memory during recalculation, but makes thecalculation slower and vice versa. Note thatmodifying this value is usually unnecessary unlessmodels are extensively large.

ThresholdForFullModelRecalculation

Integer Defines a threshold for triggering full modelrecalculation. The threshold is the amount ofinvalidated measure values after which instantinvalidation of measure values is stopped and fullmodel recalculation is automatically done after theoperation which caused the measure valueinvalidation is completed. This option can be usedto address situations where the amount ofinvalidated measure values causes memoryconsumption issues on the server. By default this is0, which makes the option to use the value of theModelRecalculationPeriodChunkSize key as thethreshold.

[SCS Communication] Section


ServerName String Hostname or the IP address of the QPR ScoreCardServer.

ServerPort Integer Socket port of the QPR ScoreCard Server.

UseEncryption Integer Defines whether encrypted communication is used.1 = yes, 0 = no.


[SCS Installation] Section

Appendices



AutoUpdate Integer Defines whether automatic Development Clientupdate is enabled. 0 = no, 1 = yes.

AutoUpdatePath String Path where the installation package for the latestversion is located.

[SCS Intermodel References] Section


RefreshStartDate String Starting date for refreshing intermodel references.Accepted date format is "<d>.<m>.<yyyy>",where <d> is day, <m> month, and <yyyy> yearwith four digits.

RefreshStartTime String Starting time for refreshing intermodel references.Accepted time format is "<hh>:<mm>:<ss>",where <hh> is hours with two digits, <mm>minutes with two digits, and <ss> seconds with twodigits.

RefreshInterval Integer Determines the refreshing interval in the precisionof 5 minutes. The length (in minutes) of the actualinterval can be calculated using the followingformula: Refresh interval * 5.

RemoveUnusedReplicaSchemaObjectsRegularly

Integer Defines whether unused replica model objects arescanned and removed regularly. Unused replicamodel objects are for instance replica element'svalue settings, which have been duplicated to thetarget model with earlier versions of QPR ScoreCardbut which are unused now. 0 = disabled (default), 1= enabled.

[SCS Log] SectionSee UMS Log

[SCS Main Form, SCC Main Form, PGC Main Form PGS Main Form, UMS Main Form, andWAS Main Form] Sections


FormLeft Integer The main form's distance from the left side of thescreen in pixels. If the value is -1, the default valuesare used.

FormTop Integer The main form's distance from the top of the screenin pixels. If the value is -1, the default values areused.

FormWidth Integer Width of the ScoreCard / ProcessGuideDevelopment Client main form in pixels.

FormHeight Integer Height of the ScoreCard / ProcessGuideDevelopment Client main form in pixels.

FormMaximized Integer Defines whether the ScoreCard / ProcessGuideDevelopment Client is maximized at startup. 0 = no,1 = yes.

Appendices


[SCS Remote Model Export] Section


RepeatAttempts Integer Controls remote model updating. 0 = disableupdating remote model. 1 = enable updatingremote model.

RepeatInterval Integer Determines how often model will be updated. Thevalue is in seconds.

RepeatTime Integer Determines for how long the ScoreCard ApplicationServer will try to update model. The value is inminutes.

[SCS Reports] Section


MaintainHierarchies Integer Enabling this property will accelerate reportgenerating, but it will also slow ScoreCardApplication Server down a little bit. 0 = no, 1 =yes.

MaintainHierarchiesRecent Integer Enabling this property will accelerate reportgenerating, but it will also slow ScoreCardApplication Server down a little bit. 0 = no, 1 = yes.

[SCS Scheduler] Section


DeletedObjectsTimeout Integer The amount of seconds after which deleted objectsare finally removed from the server. This shouldalways be several minutes to avoid errors.

[SCS Service] SectionSee UMS Service

[SCS Settings] Section


IWAEnable Integer Defines whether Integrated Windows Authentication(IWA) is enabled for QPR ScoreCard DevelopmentClient. 0 = false, 1 = true.

MaxMemoryUsage Integer Defines the maximum amount of memory inmegabytes that ScoreCard Server and Plugin areallowed to use before non-critical caches are clearedand all measure values in all models are written toQPR EMS (Extended Memory Storage). QPR EMS isused by QPR ScoreCard Server and QPR ScoreCardPlugin as an extension to the memory for storinginformation such as measure values and calculationrules. Setting this to 0 (default) disables the limit.Otherwise the minimum value is 128 and themaximum value is 3072. This setting should be usedonly if you are experiencing problems with memoryconsumption.

Appendices


[SCS Thread Priorities] Section


ClientManagerThreadPriority

Integer Thread priority of the Client Manager for Windows.

DBManagerThreadPriority Integer Thread priority of the Database Manager forWindows.

SchedulerThreadPriority Integer Thread priority of the Scheduler for Windows.

SocketAcceptThreadPriority Integer Thread priority of the Socket Accept for Windows.

[SCS Value Changed] Section


Title String Title of the e-mail notification sent when a certainvalue is changed in ScoreCard.

Text String Notification text. In the case you need to addlinefeeds, use the <NL> tag.

[SCS Value in Range] Section


Title String Title of the e-mail notification sent when a valueenters a certain range in ScoreCard.


[SCS Value Missing] Section


Title String Title of the e-mail notification about a value missingin ScoreCard.


[UMS Action Plan Category Options] Section


Option_<1...N> String Options in the Category drop-down box of an ActionPlan action.

[UMS Activation] Section





[UMS Comment Category Options] Section

Appendices



Option_<1...N> String Options in the Category drop-down box of aComment action. This section is obsolete in QPR 7.6and later. Use actiontypes.ini instead.

[UMS Communication] Section


ServerName String Hostname or the IP address of the QPR UMS.

ServerPort Integer Socket port of the QPR UMS.

Password String QPR User Management System's password(encrypted).

UseEncryption Integer Defines whether encryption is used incommunication between the UMS server and clientas well as between the UMS server and other QPRserver components. 0 = no, 1 = yes.


[UMS Document Category Options] Section


Option_<1...N> String Options in the Category drop-down box of aDocument action. This section is obsolete in QPR7.6 and later. Use actiontypes.ini instead.

[UMS Document Status Options] Section


Option_<1...N> String Options in the Status drop-down box of a Documentaction. This section is obsolete in QPR 7.6 and later.Use actiontypes.ini instead.

[UMS Initiative Status Options] Section


Option_<1...N> String Options in the Status drop-down box of an ActionPlan action. This section is obsolete in QPR 7.6 andlater. Use actiontypes.ini instead.

[UMS LDAP] Section


ServerAddress String Address of the LDAP server.

SearchBase String The distinguished name of the entry under whichthe search is performed on. If left blank, the searchstarts from the top entry.

UserName String The distinguished name of the person entry used ifthe LDAP component logs in to the LDAP serverwith a username/password combination. If leftblank, an anonymous login is used.

Appendices



Password String The userPassword attribute of the person entryused if the LDAP component logs in to the LDAPserver with a username/password combination.Leave this blank if an anonymous login is used. Theuser password is stored encrypted.

AlwaysUseSecureConnection

Integer If this is 0, then an insecure connection is usedbetween the LDAP component and LDAP server forall other functions than Authenticate.

AuthenticateViaSecureConnection

Integer If both this and AlwaysUseSecureConnection are 0,then Authentication is done with insecureconnection. If AlwaysUseSecureConnection is 1,then this setting has no effect (i.e. then itautomatically defaults to 1).

ActiveSettingGroup Integer Identification of the currently active setting group.Each setting group contains technical settings to beadjusted to the LDAP directory used.

AllowConcurrentCalls Integer This setting defines whether LDAP calls can beperformed concurrently instead of being serialized.0 = serialized calls, 1 = concurrent calls. In the casethis key is missing, 0 is used as a default value.

[UMS LDAP Setting Groups] Section


<1...N> String Name of the settings group, numbered in aconsecutive order. The settings of the settinggroups can be defined in [UMS LDAP<MyNewSetting>] sections similarly as in [UMSLDAP Standard] and [UMS LDAP Active Directory]sections.

[UMS LDAP Standard, UMS LDAP Active Directory] Sections


DistinguishedNameAttribute String Attribute name of an LDAP directory entry, whichidentifies the DN of the entry.

CommonNameAttribute String Attribute name of an LDAP directory entry, whichidentifies the full user name of the entry. Whenimporting users, this is mapped as the user name ofthe user.

EmailAttribute String Attribute name of an LDAP directory entry, whichidentifies the email address of the entry. Whenimporting users, this is mapped as the emailaddress of the user.

MemberAttribute String Attribute name of an LDAP directory entry. Thisattribute identifies one group member. An entryhaving this attribute represents some kind of group.The entry has one (MemberAttribute, DN of themember) pair for each of its members.

DescriptionAttribute String Attribute name of an LDAP directory entry, whichidentifies the description of the entry. Whenimporting users, this is mapped as the description of

Appendices



the user.

PersonFullNameAttribute String Attribute name of an LDAP directory entry, whichidentifies the full name of the user. If the value isnot defined explicitly, the default value is used, i.e.the value set to CommonNameAttribute. If the valueis defined, it overrides the default value.

UIDAttributeName String Attribute name of an LDAP directory entry, whichidentifies the user id (login name) of the entry. It ismapped as such when importing users.

UseADGlobalCatalog Integer Defines whether Global Catalog searching for ActiveDirectory objects in any domain in the forest isenabled. 1 = enabled, 0 = disabled (default).

FilterForSearchingGroups String Groups are retrieved from the LDAP directory usingthis search filter.

FilterForSearchingPersons String Users are retrieved from the LDAP directory usingthis search filter.

GroupSearchBase String The distinguished name of the entry under whichthe search is performed on. Used when searchingfor groups in LDAP. If set to <Default>, the value inSearchBase is used.

[UMS Lesson Category Options] Section


Option_<1...N> String Options in the Category drop-down box of a Lessonaction. This section is obsolete in QPR 7.6 and later.Use actiontypes.ini instead.

[UMS Log, PGS Log, PGC Log, PGP Log, SCS Log, SCC Log, SCP Log, WAS Log, Portal Log,and Plugins Log] Sections


Threshold Integer Defines the log trace mode. 255 = normal tracemode, 6577 = full trace mode.

MaxSize Integer The maximum size of the log file in kilobytes. Afterthe maximum size is searched, the old entries areoverwritten starting from the oldest entry.

Enabled Integer Defines whether logging is on. 0 = no, 1 = yes.

ThreadPriority Integer Defines the thread priority for the log writingprocess. If you wish to fine-tune your WebApplication Server performance, you can modify thisvalue. Valid values are 0-6, 0 being normal and 6 isthe highest value.

AuditTrailTrace Integer This option can be used only in the SCS Log section.Defines whether audit logging is enabled. 0 = no, 1= yes.

PerformanceLog Integer Defines whether a log file about the server'sperformance is maintained. This option can be usedonly in the UMS Log, the PGS Log, the SCS Log, andthe WAS Log (even though the field is available inthe other log sections too). The possible values are:

Appendices



0 = no performance logging, 1 = performancelogging enabled, ending of client operations arelogged, and 2 = performance logging enabled,starting and ending of client operations are logged.The performance logs are stored under the Logsfolder with the following file names depending onfor which servers the logging is enabled: WASPerfLog.txt, PGSPerfLog.txt, SCSPerfLog.txt,and UMSPerfLog.txt.

The logs write also information about the durationof the operation. There are labels for differenttimeframes to make monitoring of log files easier.The labels are as follows:

TIME_0T = the execution time was 0 msTIME_1T = the execution time was 1-9 msTIME_10T = the execution time was 10-99 msTIME_100T = the execution time was 100-999 msTIME_1000T = the execution time was 1.000-9.999msTIME_10000T = the execution time was 10.000-99.999 msTIME_100000T = the execution time was 100.000-999.999 msTIME_1000000T = the execution time was1.000.000-9.999.999 ms (about 20 minutes - 3hours)TIME_10000000T = the execution time was10.000.000-99.999.999 ms (about 3 -30 hours)TIME_100000000T = the execution time was100.000.000-999.999.999 ms (about more than 30hours)TIME_NA= execution time could not be determined,error occurred or time was greater than999.999.999 ms.

UserRightAuditTrailTrace Integer This option can be used in the SCS Log, WAS Log,PGS Log, and UMS Log sections (even though thefield is available in the other log sections too).Defines whether server user audit logging isenabled for each server separately. 0 = logging isdisabled, 1 = basic logging is enabled, 2 = fulllogging is enabled (the full logging option isavailable only for UMS Log section).

[UMS Main Form] SectionSee SCS Main Form

[UMS Risk Category Options] Section


Option_<1...N> String Options in the Category drop-down box of a Riskaction. This section is obsolete in QPR 7.6 and later.

Appendices



Use actiontypes.ini instead.

[UMS Risk Severity Options] Section


Option_<1...N> String Options in the Severity drop-down box of a Riskaction. This section is obsolete in QPR 7.6 and later.Use actiontypes.ini instead.

[UMS Risk Status Options] Section


Option_<1...N> String Options in the Status drop-down box of a Riskaction. This section is obsolete in QPR 7.6 and later.Use actiontypes.ini instead.

[UMS Service, PGS Service, SCS Service, and WAS Service] Sections


Enabled Integer Defines whether service is enabled. 1 = yes, 0 =no.

ShutDownSemaphore String Used for controlling the service. Do not modify thisvalue.

ShutDownMessage String Used for controlling the service. Do not modify thisvalue.

ControlSemaphore String Used for controlling the service. Do not modify thisvalue.

ControlMessage String Used for controlling the service. Do not modify thisvalue.

CloseMessage String Used for controlling the service. Do not modify thisvalue.

[UMS Settings] Section


MaximumNumberOfClients Integer Used internally by UMS. Do not modify.

AuthenticationMethod Integer UMS Server's authentication method. 1 = QPR, 2 =NT, 4 = LDAP, or any combination of the valuesabove. For example QPR + NT = 3

AllowProfileChangesForViewers

Integer Defines whether Portal viewer users can changetheir profile information (e-mail, password,language) in QPR Portal. 0 = no (default), 1 = yes.

UserGroupManagementMethod

Integer Defines the user group management method. 1 =Synchronized with NT/LDAP, 0 = UMS only

DefaultUserGroup String Name of a valid user group in UMS. This group isused as a default group in NT/LDAP syncronization.For more information, refer to the NT & LDAPAuthentication chapter.

PreviousAlertMsg String Used internally by UMS. Do not modify.

AlertCount Integer Used internally by UMS server. Do not modify.

ExternalObjectCacheExpirat Integer Defines how long user rights for PG and SC model

Appendices



ionTime elements are cached for faster opening of actionlists under the Actions tab in QPR Portal. Note thatchanges done to user rights within the expirationtime are not applied to QPR Portal until the cacheexpiration time is reached. The default value is 900(seconds, i.e. 15 minutes).

PortalAutoLogin Integer Defines whether login information is stored tocookies to enable automatic relogin to QPR Portal. 0= autologin enabled and option at login viewselected by default, 1 = autologin enabled, 2 =autologin disabled.

LimitedUserVisibilityInPortal Integer This setting affects the users shown in the UserSelection dialog in QPR Portal. In the case this isenabled, users without administrative rights to QPRUser Management System see only those users whobelong to at least one group the user him/herselfalso belongs to. 0 = disabled (default), 1 =enabled.

EnableActionChangeLog Integer Defines whether the change log is enabled for QPRPortal actions. 0 = disabled (default), 1 = enabled.Enabling or disabling the change log for specificaction types is done in actiontypes.ini.

EnableSSOForPortal Integer Defines whether Single Sign On is enabled for QPRPortal. 0 = no, 1 = yes.

UpdateUserInfoAtUserSynchronization

Integer Defines whether user information in QPR UMS isupdated when a user logs in with an NT or LDAPaccount. When using LDAP and this setting isenabled, the information is updated also during thenext synchronization if the user information haschanged on LDAP. The following information isupdated in the case this setting is enabled:

Full nameE-mail (LDAP only)Telephone number (LDAP only)Description

0 = disabled (default), 1 = enabled.

SynchronizationMethod Integer Defines how UMS synchronizes users and groupswith LDAP. 0 = no synchronization (default), 1 =users in groups found in both LDAP and UMS aresynchronized with a schedule defined inSynchronizationScheduleStartDate andSyncronizationSchedulerInterval keys, 2 = users ingroups found in both LDAP and UMS aresynchronized similarly as withSyncronizationMethod=1, but obsolete users (i.e.users not found in LDAP anymore) are moved to agroup defined bySynchronizationDeletedUsersGroup setting, and inthe case the group is not defined, those users aredeleted.

Appendices



WARNING: In the case synchronization is used,changing groups in LDAP may result in users andrelated data (actions, element owners) beingremoved from QPR UMS.

SynchronizationScheduleStartDate

Datetime (yyyy-MM-dd hh:mm)

Defines the initial start time of groupsynchronization which takes place ifSynchronizationMethod=1 orSynchronizationMethod=2.

SynchronizationScheduleInterval

String (dd:hh:mm)

Defines the interval between group synchronizationoperations starting from the time defined inSynchronizationScheduleStartDate. The correctformat for this setting is a colon-separated list ofdays, hours and minutes. For example, ifSynchronizationScheduleStartDate=2008-15-0101:15 andSynchronizationScheduleInterval=01:00:00, the firstsynchronization takes place on 2008-15-01 01:15and subsequent synchronizations are done everyday at 01:15.

SynchronizationExcludedGroups

String A comma-separated list of groups which areexcluded from synchronization which takes place ifSynchronizationMethod=1 orSynchronizationMethod=2. In the case a userbelongs to any of the groups listed in this setting,the synchronization does not affect that user. Notethat the group name must be contained in doublequotes in the case the name contains spaces.

SynchronizationDeletedUsersGroup

String Name of the group where users not found in LDAPare moved during synchronization (occurs ifSynchronizationMethod=2). If this is empty, theaffected users are deleted from QPR UMS. Bydefault this is "#Deleted users#".

[UMS Strategy Item Category Options] Section


Option_<1...N> String Options in the Category drop-down box of aStrategy Item action. This section is obsolete inQPR 7.6 and later. Use actiontypes.ini instead.

[UMS Strategy Item Status Options] Section


Option_<1...N> String Options in the Status drop-down box of a StrategyItem action. This section is obsolete in QPR 7.6 andlater. Use actiontypes.ini instead.

[WAS Blob Cache] Section


OnDisk Integer Defines whether embedded attachments exceedingthe size defined in the Threshold setting are storedin disk instead of memory. 1 = yes, 0 = no.

Appendices



Threshold Integer The maximum size for embedded attachments (inkilobytes) that are stored in the memory. If the sizeis exceeded, the attachments are stored in harddisk.

[WAS Communication] Section


ServerName String Hostname or the IP address of the QPR WAS.

ServerPort Integer Socket port of the QPR WAS.

[WAS Log] SectionSee UMS Log

[WAS Main Form] SectionSee SCS Main Form

[WAS Messages] Section


HTMLErrorTemplate String Template for a WAS error message.

HTMLCannotReadRequest String Template for WAS error message shown when arequest cannot be read.

HTMLCannotProcessRequest

String Template for WAS error message shown when arequest cannot be processed.

HTMLTooManyConnections String Template for WAS error message shown if there aretoo many connections to WAS open at the moment.

HTMLStartupNotComplete String Template for WAS error message shown if thestartup process has not been completed yet.

[WAS PG Publishing] Section


DaysInRecentList Integer The maximum number of days for which an event isdisplayed in the "What's New" page in QPR Portal

DefaultZoomSize String Default zoom size used for flowcharts. The valueshould be included also in the ZoomSizes entry.

ElementTypes Binary Binary entry that is used to save element typespecific web publishing options.

FlowchartPictureGeneration Integer Tells when the flowchart images are generated (0 =on model load, 1 = when flowchart is needed forthe first time).

FlowchartPictureStorage Integer The storage place of flowchart images (0 =memory, 1 = hard disk)

FooterItemCount Integer Number of footer items added into generatedflowchart pictures.

GraphicsLocation String The location of the web contents when HTML exportis used from ProcessGuide.

HeaderItemCount Integer Number of header items added into generatedflowchart pictures.

MaxFCSize Integer Defines the maximum size of flowcharts in pixels. If

Appendices



this setting has not been defined or the value is 0,the maximum size will not be used. If the maximumsize is exceeded, the flowchart will be zoomed tothe defined maximum size.

MinRecentEntries Integer Minimum amount of entries to show at the "What'sNew" page in QPR Portal.

MaxRecentEntries Integer Maximum amount of entries to show at the "What'sNew" page in QPR Portal.

MeasureHotSpot Integer Show measure value hot spot (0 = no, 1 = yes)

ModelElements Binary Binary entry that tells what model elementinformation is shown in details window. Seediscussion below.

OldModelUsage Integer Allow the usage of old model version when loadingthe new version. (0 = no, 1 = yes)

ShowHierarchy Integer The hierarchies shown in navigator. Bit 5: processhierarchy, bit 4: Organization hierarchy, bit 3: noteshierarchy, bit 2: resource groups hierarchy, bit 1:resource pools hierarchy, bit 0: informationhierarchy

ShowFlowchartLinkInDetailsLinks

Integer Show link to flowchart after every flowchart objectshown in any detail view (0 = no, 1 = yes).

ShowTransferTypeIcons Integer Show transfer type icons in the flowchart (0 = no, 1= yes).

Version String Version of the PG whose initialization filespecifications this file uses.

ViewTemplateDirectory String The directory from which the layouts are fetched

WebPageNameAttribute String The name of the custom attribute that will be usedas filename for generated HTML export pages andname of the view in dynamic web publishing. IfWebPageNameAttribute=Name, then object's namewill be used.

ZoomSizes String List of comma separated zoom sizes shown in thepublished web pages (numbers should be between10 and 200).

If HeaderItemCount has been set to something else than 0, then also following entries are used(monotonically increasing number should be appended to each entry):

Entry Value

HeaderItem Data to be shown in flowchartheader. Can be any of thefollowing:0 = Process level name1 = Process level version2 = Time of flowchart picturegeneration3 = Model creation date4 = Model last modified date

Appendices


Entry Value

5 = Page Number9 = Status

HeaderLocation 0 = Left1 = Center2 = Right

HeaderFontName Name of the font.

HeaderFontSize Size of the font.

HeaderFontBold Use bold font (0 = no, 1 = yes).

HeaderFontItalic Use italic font

HeaderFontUnderline Use underlined font

HeaderFontStrikeout Use strikeout font

HeaderFontColor Font color as decimal number in24bit RGB (16711680 equals toblue).

HeaderFontCharset Character set of the header font.

If FooterItemCount has been set to something else than 0, then every footer item has similar entriesas header items described above. The only difference is that instead of Header-prefix in every entry,Footer-prefix is used. e.g. FooterItem0=2.

[WAS Plugins] Section


<Plugin name> String Defines whether a WAS plugin is installed and used.The numeric value after the name defines the logtrace mode. 0 = normal trace, 1 = full trace.

[WAS Settings] Section


MaximumNumberOfClients Integer The maximum number of requests that are handledsimultaneously by QPR WAS. If the amount ofrequests exceeds the value defined here, newrequests will not be processed until the old oneshave been completed.

If you are having problems with a multiprocessormachine, try lowering this value to 1.

MaximumNumberOfClients_PGPLUGIN

Integer The maximum number of requests that are handledsimultaneously by QPR ProcessGuide Plugin (i.e. theWeb Client). If the amount of requests exceeds thevalue defined here, new requests will not beprocessed until the old ones have been completed.

MaximumNumberOfClients_QPRPORTAL

Integer The maximum number of requests that are handledsimultaneously by QPR Portal. If the amount ofrequests exceeds the value defined here, newrequests will not be processed until the old oneshave been completed.

MaximumNumberOfClients_SCPLUGIN

Integer The maximum number of requests that are handledsimultaneously by QPR ScoreCard Plugin (i.e. theWeb Client). If the amount of requests exceeds the

Appendices



value defined here, new requests will not beprocessed until the old ones have been completed.

MaximumNumberOfClients_QPRWAS

Integer The maximum number of internal (for exampleLogin procedures and error messages) requests thatare handled simultaneously by QPR WAS. If theamount of requests exceeds the value defined here,new requests will not be processed until the oldones have been completed.

WebContentRoot String The URL for the Web Contents on the Web server.Note that http://127.0.0.1 cannot be used here ifthe QPR Web Application Server is accessed fromother computers or the web server is installed onsome other computer. This must be the IP addressor the web server's server name (for example"myserver.com").

HostScriptLocation String The URL for the CGI-binary on the Web server.Note that a localhost address like http://127.0.0.1/cgi-bin/qpr.exe cannot be used here if the QPR WebApplication Server is accessed from other computersor the web server is installed on some othercomputer. This must be the IP address or the webserver's server name (for example "myserver.com").

SessionExpirationTimeout Integer The maximum idle time in seconds before thesession expires and user is forced to log in again.

SessionLogoutExpirationTimeout

Integer The time in seconds that a user's session remainsactive after logout. Used in demo portals, where allusers use the same User information. If some userlogs out, the session still remains valid for the givenexpiration time. Setting this value to 0 (default)makes the user's session to expire immediatelyafter logout.

UseDefaultLoginView Integer Show the default or customized view in the loginview. 1 = default, 0 = custom.

CustomLoginURL String URL of the view shown in the login view if thedefault login view is not used.

TemplateRoot String Root folder for all the template folders. If thissetting has not been defined, the <All Usersprofile>\Application Data\QPR Software\QPR 8\8.1\Templates\WAS folder (C:\ProgramData\QPRSoftware\QPR 8\8.1\Templates\WAS folder inWindows Vista and later versions) is used bydefault.

ReadOnlyMode Integer Defines whether Portal is in read-only mode. 0 =no, 1 = yes.

MaxMemoryUsage Integer Defines the maximum amount of memory inmegabytes QPR Web Application Server is allowedto consume. This setting affects e.g. the amount ofmodels cached in the memory and therefore alsofor instance searches.

MemoryUsageLimit Integer Defines the per cent value of the threshold for the

Appendices



MaxMemoryUsage when the memory limit has beenexceeded, so that WAS will drop models frommemory until memory usage is <value>% underthe specified MaxMemoryUsage. The default valueis 20.

IWAEnable Integer Defines whether Integrated Windows Authentication(IWA) is enabled for QPR Portal. 0 = false, 1 = true.

IWACGIBinaryIP String Deprecated. CGIBinaryIP is now used, but in thecase this key has a value and CGIBinaryIP isundefined, the value of this key is read into theCGIBinaryIP key.

CGIBinaryIP String Defines the IP of the computer where QPR.exe orQPR.dll is located. This option needs to be set onlywhen IWAEnable or EnableSSOForPortal (in UMSSettings section) is set to 1.

CachePages Integer Defines whether HTML pages generated by QPRPortal are cached in the browser cache. Thefollowing values can be used: 0 = never cachepages, 1 = disabled by default, i.e. pages are notcached unless explicitly requested to do so. 2 =enabled by default, i.e. pages are cached unlessexplicitly requested not to do so. By default thevalue is 1.

ForcePlainTextURLs Integer Defines whether QPR Portal URLs are encrypted(user account data is always encrypted regardlessof this setting). 1 = plain text URLs are used, 0 =URLs are encrypted. By default the value is 1.

EnableTemplateCaching Integer Defines whether Portal templates are cached in QPRWeb Application Server. Disabling this is helpfulwhen customizing templates, as the templates arerefreshed without restarting QPR Web ApplicationServer. 1 = yes, 0 = no. By default the value is 1.

EnableWorkFlow Integer Defines whether the link to QPR WorkFlow isenabled in QPR Portal. 1 = enabled, 0 = disabled.By default the value is 0.

EnableFactView Integer Defines whether the link to QPR FactView (a tabcalled Analytics) is enabled in QPR Portal. 1 =enabled, 0 = disabled. By default the value is 0.

UIYearOffset Integer With this key you can define an offset (positive ornegative) to be applied to the year values displayedin QPR Portal to accommodate for differentcalendars. Note that this setting affects only howthe values are displayed, so calculations are notaffected and two QPR Web Application Servers canutilize the same database with different offsets.However, negative offsets large enough to causenegative year values to be displayed in QPR Portalshould not be used.

Note that this setting affects also situations whereaction attribute values of the type date are

Appendices



inputted. In those cases a reverse offset is appliedto the values before inputting them to the databasein order to maintain database consistency.

WebContentPath String Path where the QPR web contents are installed.

DefaultPortalMode Integer Defines the QPR Portal mode that is used for a userthat hasn't previously logged into QPR Portal. 0(default) = Standard Portal, 1 = Mini Portal.

HidePortalModeChange Integer Defines whether a button is shown in QPR Portal forchanging the Portal mode between Mini Portal andStandard Portal. 0 (default) = button is shown, 1 =button is hidden.

DefaultDetailsPaneMode Integer Defines the default mode of the Details Pane in QPRPortal. 0 = disabled, 1 (default) = minimized, 2 =open. Note that this setting is overridden if user-specific Details Pane mode is set in QPR PortalSettings page.

HideDetailsPaneModeChange

Integer Defines whether it is possible to change the DetailsPane mode in QPR Portal or not. 0 (default) =Details Pane mode change is allowed, 1 = DetailsPane mode change is not allowed.

FactViewUserGroup String Defines the user groups of QPR User ManagementSystem whose members have the QPR FactViewlink (Analytics tab) visible in QPR Portal. To addmultiple group names, separate the names with acomma (e.g. "FactViewUserGroup=Group1,Group2,Group3").

[WAS Service] SectionSee UMS Service

[WLT Customer Info] Section


CustomerCode String Customer's Product Activation Code

FirstName String Customer's first name

LastName String Customer's last name

Email String Customer's e-mail address

PhoneNumber String Customer's phone number

Address String Customer's address

PostalCode String Customer's zip/postal code

City String Name of the city the customer lives in

Country String Name of the country the customer lives in

Organization String Customer's organization

JobTitle String Customer's job title

UserComments

String Customer's comments

PortalFullUsers Integer Amount of activated Portal Communicator Users.This key is used during upgrade in the case license

Appendices



file does not exist.

PortalViewUsers Integer Amount of activated Portal Viewer Users. This key isused during upgrade in the case license file doesnot exist.

SCDclientUsers Integer Amount of activated ScoreCard Designer users. TheScoreCard Server checks this value at startup, and ifthe amount of Designer users in UMS exceeds thisvalue, the ScoreCard Server does not start.

PGDclientUsers Integer Amount of activated ProcessGuide Designer users.The ProcessGuide Server checks this value atstartup, and if the amount of Designer users in UMSexceeds this value, the ProcessGuide Server doesnot start.

[WLT Modes] Section


UseSilentForTransient Boolean Defines whether transient product activation is donein a silent mode.

ShowTransientExpirationWarning

Integer Defines how many days before expiration thewarning is shown. Default value is 0 meaning nowarnings.

LicModes String Defines what licensing modes are available. Validoptions are evaluation, internet, web, manual

UseSilentForFirstActivation Boolean Defines whether the QPR Product Activation Wizardis started in the silent mode when the product isinstalled (requires certain prerequisites to be met,see the QPR Product Activation chapter for moredetails). 0 = no, 1 = yes.

[WLT Settings] Section


LicensingServers String Domain name of QPR Product Activation Server.There can be domain names separated by ';'

LicensingPage String Rest of URL for automatic product activation viaWeb

LicenseFormPage String URL for manual product activation via Web

ManualActivationURL String URL for manual product activation via phone/e-mail.

SSLPort Integer Socket port of the SSL server

SSLProxyServer String IP address of the SSL proxy server

SSLProxyPort Integer Socket port of the SSL proxy

Timeout Integer Timeout in milliseconds for socket connections

Email String QPR's Customer Care e-mail address for manualproduct activation instructions

Helpdesk String QPR's Support site's contact information for manualproduct activation instructions.

Appendices


12.2 Appendix B: Windows Registry Usage

The QPR 8 installation writes some entries to the Windows Registry under theHKEY_LOCAL_MACHINE\Software\QPR Software Plc. folder. The registry keys are as follows:

Entry Value Example

CGIPath Indicates where the CGI binary and scriptfiles as well as ISAPI DLL are installed.Note that if several CGI installations existin the same computer, the location is thelocation of the latest installation.

C:\inetpub\scripts

InstallPath Indicates where the QPR suite is installed.Note that if several installations exist in thesame computer, the location is the locationof the latest installation.

C:\ProgramFiles\QPR 8

WebContentsPath Indicates where the QPR Web ApplicationServer's web contents (HTML and relatedfiles) are installed. Note that if severalinstallations exist in the same computer,the location is the location of the latestinstallation.

C:\inetpub\wwwroot

Registry entries under \HKEY_LOCAL_MACHINE\Software\QPR Software Plc\QPR Home 8.0

Entry Value Example

Office2007Addin Indicates whether QPR Add-In forMicrosoft Office 2007 is installed.

1

PGApplicationServer Indicates whether QPR ProcessGuideApplication Server is installed.

1

PGDevelopmentClient Indicates whether QPR ProcessGuideDevelopment Client is installed.

1

QPRWebServices Indicates whether QPR Web ServicesFoundation is installed.

1

SCApplicationServer Indicates whether QPR ScoreCardApplication Server is installed.

1

SCDevelopmentClient Indicates whether QPR ScoreCardDevelopment Client is installed.

1

UserManagementClient Indicates whether QPR User ManagementClient is installed.

1

UserManagementServer Indicates whether QPR User ManagementServer is installed.

1

WASAndPlugins Indicates whether QPR Web ApplicationServer and plugins running on it areinstalled.

1

WASScripts Indicates whether a QPR Web ApplicationServer's scripts (CGI binary & ISAPI DLL)are installed.

1

WASWebContents Indicates whether QPR Web ApplicationServer's Web Contents are installed.

1

Registry entries under \HKEY_LOCAL_MACHINE\Software\QPR Software Plc\QPR Home 8.0\InstalledFeatures

Appendices


In the case QPR Add-In for Microsoft Office 2007 is installed, a QPR Software Plc.QPR Add-in forMicrosoft Office branch is created under \HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\12.0\User Settings. When Word is started up for the first time after the installation, the same branch iscopied also under HKEY_CURRENT_USER\Software\Microsoft\Office\12.0\User Settings.

In addition, the Windows Installer engine creates various entries that are necessary for uninstallationand upgrades.

12.3 Appendix C: Running Multiple Versions Simultaneously

While QPR 8.1 can be installed side-to-side with earlier QPR versions rather easily (all the defaultfolders are different), there are still a few issues you need to take into account if you are running bothQPR 8.1 and an older version simultaneously.

Server Ports

The default ports are the same in QPR 8.1 as in the earlier versions. In order to run QPR 8.1 and anolder version simultaneously, port numbers for either version need to be changed. See theinstructions regarding port changes in the "Parallel (side-by-side) installations of QPR 8.1"section.

Script Clients

If you use QPR scripting and have multiple versions installed, the version that runs scripts double-clicked in Windows Explorer is the latest version that is installed. If you need to change this, do thefollowing:

1. Open the command prompt2. Go to the currently registered version's ProcessGuide/ScoreCard installation folder depending on

which you're registering (folders that contain QPR.PG.Client.exe/Proguide.exe or QPR.SC.Client.exe/SCClient.exe respectively)

3. Run QPR.PG.Client.exe /unregserver or QPR.SC.Client.exe /unregserver depending on the client.Note that the exe names were proguide.exe and scclient.exe respectively on versions up to theinitial release of QPR 8.0.

4. Go to the corresponding folder for the version with which you want to open the scripts and runProguide.exe /regserver or SCClient.exe /regserver.

Parallel (side-by-side) installations of QPR 8.1

1. Copy the QPR 8 installation folder under a new name, for example QPR 81_Instance2.2. Launch some executable from the new folder so that the settings are instantiated.3. Make a copy of your existing database and create a new, version-specific ODBC data source for

it, for example QPR_81_2.4. Create a version specific web content folder under your web server and copy the qprsoftware

folder there. So if the webcontents are installed in, for example, C:\InetPub\wwwroot\qpr81\qprsoftware, the new folder should be e.g. C:\InetPub\wwwroot\qpr81_2\qprsoftware. Notethat it is essential that the name of the qprsoftware folder is not changed.

5. Similarly create a new folder for the CGI binary and ISAPI DLL and copy QPR.exe, QPR.dll and

Appendices


qprsettings.dat into that folder.6. Go to the new version's folder and use the QPR Configuration Manager utility to change the

data source and the port numbers (increment every number by 1, for example) to avoidoverlaps with the new version. Also change the webcontent folder entries. Consult the tablebelow for information about the required changes:

Section Group Change

Common Database operations Change the data source to instance-specificone.

Common Server locations Change the port numbers for all servers

QPR Web Application Server General Change the web content URL to point atwhere the new instance files are installed. Youmay need to add a new virtual directory toMicrosoft IIS at this point and update thevalue correspondingly.

QPR Web Application Server General Change the script location to point at wherethe new instance files are installed. You mayneed to add a new virtual directory toMicrosoft IIS at this point and update thevalue correspondingly.

QPR Web Application Server QPR ScoreCard Plugin If this value hasn't changed automatically,change the Web file publishing directory andthe Web file publishing URL to point to thenew folders.

7. Locate the qpr.ini file that corresponds to the installation. You can determine its location bygoing to <path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\ folder (C:\ProgramData\QPR Software\QPR 8\8.1\ in Windows Vista and later versions) and checking thecontents of the instances.ini file located there. Check the instance under which the installationfolder is the one you created in step 1. The correct qpr.ini file will be located inSettings\<Instance> folder relative to the folder containing the instances.ini file. Open the qpr.ini in the instance-specific folder and change the value of WebContentPath in [WAS Settings]section to point to the folder created in step 3, without the qprsoftware part included in thename, i.e. in the case of the example folder the setting should be WebContentPath=C:\InetPub\wwwroot\qpr81_2\.

8. Similarly, under the [WAS Settings] section add the TemplateRoot setting that points to thetemplate folders used by the instance. The template folder will be Templates\<Instance>\WASrelative to the folder containing the instances.ini file, i.e. in the case of the example the settingshould be TemplateRoot=C:\Documents and Settings\All Users\Application Data\QPRSoftware\QPR 8\8.1\Templates\Instance_2\WAS.

9. Open the qprsettings.dat file in the folder you created in step 5 and change the value ofHOST_PORT to be the same you defined for QPR Web Application Server in the Serverlocations section. If you are using qpr.dll, you need to restart IIS (e.g. by running iisreset)before the new ports are in use.

10. If you want to run also the other servers as a service, first you need to open the qpr.ini file inthe folder created in step 2 and update the values of InternalName and InternalBaseNamekeys in the [QPR Service] section to something else than the default ones (for instanceQPR_81_2), but use the same value for both keys. After the qpr.ini modifications, you can startthe service installation by opening the command prompt and running 'qprinit -i' in the Utilitiesfolder.

11. Change the Development Clients of the parallel installation to use the new port numbersdefined in step 6.

12. If you want to activate the parallel installation separately, open the instance-specific qpr.ini andmodify the DefaultLicPath keys under the [<product> Activation] sections to contain the name

Appendices


of the instance folder (for example DefaultLicPath=umsauth.bin becomesDefaultLicPath=Instance 2\umsauth.bin). After that you need to create an instance folderunder the License folder. For example, if the instance-specific qpr.ini is in the Settings\Instance2 folder, the new folder under the License folder should also be called Instance 2. Finally youneed to copy the clear activation status files (*auth.bin) file from the installation folder (e.g. C:\Program Files\QPR 8) to the License\Instance 2 folder. Now you can proceed to activate thenew instance separately.

Both installations can now be used simultaneously. Note that you need to modify the links pointing tothe old Portal to point at the new folder. Also note that the parallel version can be removed orupgraded only manually.

12.4 Appendix D: QPRSettings.dat File

This chapter describes the contents of the qprsettings.dat file located in the script installation folder.Note that when using qpr.dll with Microsoft IIS, restarting only QPR Web Application Server is notsufficient to get qprsettings.dat changes into use, but you also need to restart IIS e.g. by runningiisreset.

The following settings can be defined in the qprsettings.dat file:

Key Type Description

HOST_ADDR String TCP/IP address of the QPR Web Application Servercomputer.

HOST_PORT Integer Socket port number of the QPR Web ApplicationServer.

MAX_UPLOADED_FILE_LENGTH Integer The maximum allowed size of uploaded files inbytes.

MSG_PAGE_HEADER String This is the text that is shown in the error messagewindow title. Note also that this parameter has thestart tags for the created error page.

MSG_CONNECTION_FAILED String This is the message that is shown to the user if CGIbinary cannot open connection to QPR WebApplication Server.

MSG_REQUEST_FAILED String This is the message that is shown if the userrequest could not be processed (invalid format,connection to QPR WAS lost in the middle ofprocessing, etc)

MSG_RESPONSE_FAILED String This is the message that is shown if the response touser's request could not be processed (invalidformat, illegal data, or some other error)

MSG_UPLOADED_FILE_TOO_LONG

String This is the message that is shown if the file that isbeing uploaded into QPR Portal exceeds the limit setfor the size of the uploaded files.

MSG_PAGE_FOOTER String This shows the possible footer text for the errormessage. Note that it also has the end tags for thecreated error message page.

LOG_ENABLE Boolean Defines whether logging is enabled for qpr.exe. Seebelow for other requirements concerning logging. 1= yes, 0 = no.

Appendices


Key Type Description

LOG_THRESHOLD Integer Defines what entries are written into the log file. Ifthreshold is 255 or below, only errors are logged.With threshold of 511 or below both errors andwarnings are logged, and with threshold of 65535 orbelow, notifications, warnings and errors arelogged.

LOG_MAX_SIZE Integer Maximum size of the log file in kilobytes.

LOG_FILE_NAME String Name of the log file.

LOG_RESPONSE_ENABLE Integer Defines whether HTTP headers qpr.exe sends toweb server are written to the log. 0 = no headersare written, 1 = headers are written into thecgibinresponse.txt file, 2 = headers and full contentare written into the cgibinresponse.txt file.

HOST_OVERRIDE String Overrides the host set into HTTP headers of therequest received by web server and CGI binary(qpr.exe). This is useful e.g. in situations where anauthentication system modifies the headers andcauses unnecessary redirects to QPR WebApplication Server. These kinds of issues can besolved by setting this to the same host as defined inthe Script location setting in QPR ConfigurationManager.

HDR_VAR_USR String Name of the HTTP header variable that stores thelogin name of an authenticated user when usingSingle Sign On (SSO) authentication with QPR Portal

Enable CGI Binary LoggingEnabling logging for CGI binary (qpr.exe) operations is usable for temporary troubleshooting. Toenable logging, do the following:

1. Copy the log.dll file from <QPR 8 installation root>\Utilities folder to the CGI binary folder2. Change the value of the LOG_ENABLE key to 1.

Note that generating the log files requires that the IIS/Apache process user has write access to theCGI binary folder. Also note that logging should be used only temporarily and in the case there arepersistent problems, please contact QPR Customer Care.

12.5 Appendix E: Changing Web Server

This appendix describes the procedure required for changing the web server (e.g. from Microsoft IISto Apache or vice versa) on which QPR Portal runs.

1. Run a modify installation and select to remove the QPR Portal Web Contents2. Run a modify installation again and select the QPR Portal Web Contents to be installed again.3. During the reinstallation, select the CGI binary and web contents folders according to the new

web server. For Microsoft IIS the default CGI binary folder is scripts and the default web contentsfolder is wwwroot. For Apache the default CGI binary folder is cgi-bin and the default webcontents folder is htdocs.

4. When the QPR Configuration Manager is launched after the installation, open the Web content

Appendices


tab under the QPR Web Application Server settings and verify that especially the script locationsetting uses the correct CGI binary folder name. In the case the web contents were installedunder the root level of the web contents folder, the "Web content URL" setting can remainuntouched.

5. Go to the WAS plugins tab under the QPR Web Application Server settings, select SCPLUGIN andclick the Configure button.

6. Open the Web File Publishing tab and update the paths according to your new web server.7. Close the QPR Configuration Manager and open the qpr.ini file located in the <path to All Users

profile>\QPR Software\QPR 8\8.1\Settings\<possible instance folder> folder (C:\ProgramData\QPR Software\QPR 8\8.1\Settings\<possible instance folder> in Windows Vistaand later versions) into a text editor.

8. Search for WebContentPath setting (located in the WAS Settings section) and update its value tocorrespond with your new web server.

9. Start the new server and QPR server components. QPR Portal is now running on the new server.Note that you'll need to update your links/bookmarks, as the CGI binary folder has most likelychanged.

12.6 Appendix F: Audit Logs and User Audit Logs

This chapter describes the audit logs which can be used to log selected operations in the servers ofQPR applications. There are two types of audit logs available; audit logs, which record the changesmade to values of elements and model operations, and user audit logs, which record the changesmade to user rights.

12.6.1 Audit Logs

Audit logs to record the changes made to values of elements and model operations can be enabledfor QPR ScoreCard and QPR ProcessGuide.

12.6.1.1 Audit Log for QPR ScoreCard

All operations targeted at a QPR ScoreCard model can be recorded into a log file called "SCSAudit.txt"located in the folder that can be defined in the General tab of the Common settings section in theQPR Configuration Manager utility. To enable logging, launch QPR Configuration Manager, open QPRScoreCard Server settings, open the General tab and check the Enable audit log checkbox.

The Structure of the Log File

When the audit trail writing is enabled, a session entry will be written into the log file. In each entrythere is a header, event, and footer section.

Header Section

The header section starts the session, and it will be written into the log file when the ScoreCardApplication Server is started. Header contains a time stamp, such as the following:

### Audit Trail logging started at 4.3.2003 17:44:55 ###

Appendices


Event Section

When an operation (action) is committed to the ScoreCard Application Server (or a DatabaseManagement System), a corresponding event will be written into the log file to the event section. Thefollowing actions are recorded:

manual input of a new valuemanual change of a valuemanual delete of a valuevalue inputted by a scheduled SQL importvalue inputted by a SQL mass importvalue inputted by an Olap importvalue inputted by an Olap mass importvalue changed by a scheduled SQL importvalue changed by a SQL mass importvalue changed by an Olap importvalue changed by an Olap mass import

NoteCalculated values are not recorded.

An entry (a record) in the event section contains the following data (fields) on action:

When the action was made?date: <mm>/<dd>/<yy>time: <hh>:<mm>:<ss>

Who made the action?login name: <user's login name>user name: <user's real name>

What was the target?name of the model: <model name>scorecard symbol: <scorecard symbol>name of the scorecard: <scorecard name>element symbol: <element symbol>name of the element: <element name>series symbol: <series symbol>name of the series: <series name>name of the period: <period name>

What kind of an action was made?type of an action: User | System <import name>action: Value Change | Value Deletion

Value after and before the action.previous value, formatted according to value's unit: <null> | <value>current value, formatted according to value's unit: <null> | <value>value's unit: <unit>

Record's end mark is a line feed (LF+CR) and fields are separated with tabulators.

Footer Section

The footer section ends the session, and it will be written into the log file when the ScoreCard

Appendices


Application Server is shut down. Footer contains a time stamp, such as the following:

### Audit Trail logging stopped at 5.3.2003 17:44:55 ###

WarningAudit log file can become very large.

12.6.1.2 Audit Log for QPR ProcessGuide

All operations targeted at a QPR ProcessGuide model can be recorded into a log file called "PGSAudit.txt" located in the folder that can be defined in the General tab of the Common settings section in theQPR Configuration Manager utility. Logging is enabled by default. To disable logging, you have tomodify the qpr.ini file by changing the value of AuditTrailTrace to 0 in [PGS Settings].


When an operation (action) is committed to the ProcessGuide Application Server, a correspondingevent will be written into the log file. The operation is one of the following:

Open model for viewingOpen model for editingOpen model for exclusive editingCheck out model for editingCheck out model for exclusive editingSave modelSave model asSave template asCheck inUndo checkoutClose modelDelete modelReplace model

The log contains the following columns:

TimeDateModel nameModel idUser, full name and login nameSession idAction

The fields of the log file are separated with tabulators.

Appendices


12.6.2 User Audit Logs

User audit logs can be enabled for QPR ScoreCard, QPR Web Application Server, QPR ProcessGuide,and QPR User Management Server.

12.6.2.1 User Audit Log for QPR ScoreCard Server

Operations related to user administration and user rights in QPR ScoreCard Server can be recordedinto a log file called "SCSUserAudit.txt". If logging is enabled, the log file is generated to the <AllUsers profile>\Application Data\QPR Software\QPR 8\8.1\Logs\ (C:\ProgramData\QPR Software\QPR8\8.1\Logs\ in Windows Vista and later versions) folder (defined with qpr.ini key 'Folder' in [QPR Log]section). To enable logging, you have to modify the qpr.ini file by changing the value ofUserRightAuditTrailTrace to 1 in [SCS Log]. By default, the logging is off.

The changes audited for user administration include changing model specific rights for the selecteduser(s) or group(s). The changes audited for user rights include the access level rights for a specificobject(s) or branch(es).


The fields of the log file are separated with tabulators. Each row contains a separate transaction madefor a particular user or a group.

The log file includes the following data:

Field Format Description

TIME <hh>:<mm>:<ss> Time stamp when the transaction ismade

DATE <mm>/<dd>/<yy> Time stamp when the transaction ismade

USER LOGIN <user's login name> Login name for the user performing thetransaction

USER NAME <user's real name> Full name of the user performing thetransaction

MODEL NAME <model name> Used model

OPERATION GrantRevoke

Single operation performed

TARGET USER <name of targeted user> User object against whom the operationis performed

TARGET GROUP <name of targeted group> Group object against whom theoperation is performed

ELEMENT TYPE NAME <name of targeted elementtype>

Element type against whom theoperation is performed

ELEMENT TYPEPERMISSION

<grant> None Rights<grant> View Rights<grant> Update Rights<grant> Full Rights<revoke> Rights

Changed element type rights

OBJECT NAME <name of targeted object> Object against whom the operation is

Appendices



performed

OBJECT PERMISSION <grant> None Rights<grant> View Rights<grant> Update Rights<grant> Full Rights<revoke> Rights

Changed object specific rights

The operations that are possible and appropriate to write are 'GRANT' and 'REVOKE'. Theseoperations can be related to:ELEMENT TYPE RIGHTMODEL RIGHTOBJECT RIGHT

The possible values for MODEL_RIGHT are as follows:<grant>/<revoke> Model User<grant>/<revoke> Model Administrator

For example:'Revoke Model User''Grant Model Administrator'

Example Log File Contents

TIME DATE USERLOGIN

USERNAME

MODELNAME

OPERATION

TARGETUSER

TARGETGROUP

ELEMENT TYPENAME

ELEMENT TYPERIGHT

OBJECTNAME

OBJECTRIGHT

16:11:05 11/19/07 qpr DemoUser

DentorexGroupScorecard

GrantModelUser

Full nameof newuser

- - - - -

16:11:09 11/19/07 qpr DemoUser


GrantElementtypeRight

Full nameof newuser

- CriticalSuccessFactor

View - -

16:14:27 11/19/07 qpr DemoUser


GrantObjectRight

Full nameof newuser

- - - Financial Update

12.6.2.2 User Audit Log for QPR Web Application Server

Selected operations performed in QPR Portal can be recorded into a log file called "WASUserAudit.txt".If logging is enabled, the log file is generated to the <All Users profile>\Application Data\QPRSoftware\QPR 8\8.1\Logs\ (C:\ProgramData\QPR Software\QPR 8\8.1\Logs\ in Windows Vista andlater versions) folder (defined with qpr.ini key 'Folder' in [QPR Log] section). To enable logging, youhave to modify the qpr.ini file by changing the value of UserRightAuditTrailTrace to 1 in [WAS Log].By default, the logging is off.

The changes audited include the following QPR Portal operations:Logging inLogging outOpening a model

Appendices


Session timeout









PRODUCT NAME <product name> Product accessed

MODEL NAME <model name> Model accessed

OPERATION LoginLogoutOpen ModelSession Timeout


CLIENT IP <client IP address> IP address of the client machine


TIME DATE USER LOGIN USER NAME PRODUCTNAME

MODELNAME

OPERATION CLIENT_IP

9:58:25 11/20/07 qpr Demo User - - Login 10.0.20.172

9:58:48 11/20/07 qpr Demo User ProcessGuide GB Open Model

9:59:25 11/20/07 qpr Demo User ProcessGuide PG model Open Model

10:14:51 11/20/07 qpr Demo User - - Logout 10.0.20.172

11:57:57 11/20/07 qpr Demo User - - Login 10.0.20.172

11:57:59 11/20/07 qpr Demo User ProcessGuide GB Open Model

11:58:02 11/20/07 qpr Demo User ScoreCard DentorexGroupScorecard

Open Model

Appendices


12.6.2.3 User Audit Log for QPR ProcessGuide Server

Operations related to user administration in QPR ProcessGuide Server can be recorded into a log filecalled "PGSUserAudit.txt". If logging is enabled, the log file is generated to the <All Usersprofile>\Application Data\QPR Software\QPR 8\8.1\Logs\ (C:\ProgramData\QPR Software\QPR 8\8.1\Logs\ in Windows Vista and later versions) folder (defined with qpr.ini key 'Folder' in [QPR Log]section). To enable logging, you have to modify the qpr.ini file by changing the value ofUserRightAuditTrailTrace to 1 in [PGS Log]. By default, the logging is off.

The changes audited for user administration include changing the process level rights and modelingrights for the selected user(s) or group(s).

The operations are logged when changes are saved to the database, i.e. when the model is saved tothe server.





TIME <hh>:<mm>:<ss> Time stamp of when the transaction ismade

DATE <yyyy>/<mm>/<dd> Date stamp of when the transaction ismade

LOGIN <user's login name> Login name for the user performing thetransaction


MODEL NAME <model name> Used model

OPERATION <grant>/<revoke> Single operation performed

TARGET USER <targeted user's name> User object against whom the operationis performed

TARGET GROUP <targeted group's name> Group object against whom theoperation is performed

PROCESS LEVEL <targeted process levelname>

Process level against whom theoperation is performed

NEW PROCESS LEVELRIGHT

No RightsView OnlyModify

Changed process level right

NEW MODELING RIGHT Model AdministratorMeasuresResourcesSimulation

Changed modeling right

The possible operations to be recorded are 'GRANT' and 'REVOKE'. These operations can be related tothe following actions:

PROCESS LEVELMODELING RIGHT

Appendices



TIME DATE LOGIN USERNAME

MODELNAME

OPERATION

TARGETUSER

TARGETGROUP

PROCESSLEVEL

NEWPROCESSLEVELRIGHT

NEWMODELINGRIGHT

16:07 19.11.2007

qpr DemoUser

PG model GRANT Full nameof newuser

View Only Resources

16:07 19.11.2007

qpr DemoUser


PG model Modify

16:07 19.11.2007

qpr DemoUser


sub-level Modify

16:15 19.11.2007

qpr DemoUser


sub-level View Only

12.6.2.4 User Audit Log for QPR User Management Server

Selected operations performed in QPR User Management Server can be recorded into a log file called"UMSUserAudit.txt". If logging is enabled, the log file is generated to the <All Usersprofile>\Application Data\QPR Software\QPR 8\8.1\Logs\ (C:\ProgramData\QPR Software\QPR 8\8.1\Logs in Windows Vista and later versions) folder (defined with qpr.ini key 'Folder' in [QPR Log]section). To enable logging, you have to modify the qpr.ini file by changing the value ofUserRightAuditTrailTrace to either 1 (to enable basic logging) or 2 (to enable full logging) in [UMSLog]. By default, the logging is off.

The changes audited include the following QPR User Management Server operations:Changing the product permissions methodChanging product permissions (user or group specific)Adding or deleting users and groups (includes manual user import with QPR User ManagementSystem Client and synchronization with AD or LDAP)




Field Format or value Description





Appendices


Field Format or value Description

OPERATION Grant/Revoke forpermissionsAdd/Delete for objects


TARGET USER <targeted user's name> User object against whom the operationis performed

TARGET GROUP <targeted group's name> Group object against whom theoperation is performed

PRODUCT PGDC: QPR ProcessGuideDevelopment Client PGP: QPR ProcessGuideWeb ClientSCDC: QPR ScoreCardDevelopment ClientSCP: QPR ScoreCardWeb ClientPORTAL: QPR PortalUMS: QPR UserManagement System

Product object against which theoperation is performed

PERMISSION Basic/Administrate forPGDC, PGP, SCDC andSCPView/Update/Administrate for PORTALand UMS

Changed product permission

PRODUCT PERMISSIONMETHOD

Inherit From GroupUse SystemAdministratorUse User Specific

Changed product permission method

If the full logging option is selected and the operation is made for a group to modify group specificpermissions, separate log entries for each user (member of the group) are written to the log file. Ifthe user group management method is synchronized with NT or LDAP, the 'LOGIN' is 'system' and the"Grant User Permissions" lines are written only if full logging is selected, since the user uses thegroup's rights.

Note that the user's group synchronization is done only when the user logs in to the system and theaudit log reflects the current situation in the User Management System database, not necessarily thesituation in NT or LDAP. Thus, the audit log may contain information that is not up-to-date but theinformation is automatically updated the next time the user logs in since the user is at that pointremoved from the old group(s) and added to the new one(s) and the audit log entries are written forthis change.


TIME DATE USERLOGIN

USERNAME

OPERATION

TARGETUSER

TARGETGROUP

PRODUCT PERMISSION

PRODUCTPERMISSIONMETHOD

16:00:42 11/19/07 qpr Demo User Add User new user - - - -

16:00:42 11/19/07 qpr Demo User Grant new user - - - Use User

Appendices


TIME DATE USERLOGIN

USERNAME

OPERATION

TARGETUSER

TARGETGROUP

PRODUCT PERMISSION

PRODUCTPERMISSIONMETHOD

ProductMethod

Specific

16:00:42 11/19/07 qpr Demo User Grant UserPermissions

new user - PORTAL Administrate

-

16:00:42 11/19/07 qpr Demo User Grant UserPermissions

new user - PGP Basic -

12.7 Appendix G: QPR Transfertool Command Line Parameters

This chapter describes some of the command line parameters for the QPR Transfertool databaseoperations.

Note: Databases earlier than 7.4 are not supported.

Do not use these operations unless you know what you are doing.

Always remember to backup your database before doing any operations, as there is noway to revert to the previous state once the operations are finished!

Create Database

By starting QPR Transfertool with the /CREATE_DB parameter it is possible to create a new database.Note that a database must already exist as this command will only create the QPR table structure intothe database, i.e. it cannot create a completely new database from scratch.

Note that it is possible to overwrite an existing database using this parameter!

Parameters

/dt:<DB> Target database name.

/dt_user:<username> Target database username.

/dt_pwd:<user'spassword>

Target database password.

/LOG:<location andname name of log file>

The specific location and filename for the log created by Transfertool. If notspecified, Transfertool will write a log into the <path to all usersprofile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case ofWindows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1\Logs

/NOCONFIRM Do not ask for confirmations.

/DEBUG:<location andname name of log file>

Write a debug log file to the specified location.

/SILENT No UI is shown. When using this parameter, /NOCONFIRM is not needed.

ExampleQPR.TransferTool.exe /CREATE_DB /dt:QPR_81_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt /NOCONFIRM

Always remember to backup your database before doing any operations, as there is no

Appendices


way to revert to the previous state once the operations are finished!

Export File

By starting QPR Transfertool with the /export_FILE parameter it is possible to export a database intoa file.

Parameters

/FILE:<location andname name of targetfile>

Location and filename where the data is exported to.

/ds:<DB> Source database name.

/ds_user:<username> Source database username.

/ds_pwd:<user'spassword>

Source database user's password.


The specific location and filename for the log created by Transfertool. If notspecified, Transfertool will write a log into the <path to all usersprofile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case ofWindows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1\Logs

/NOCONFIRM Do not ask for confirmations

/DEBUG: Write a debug log file to the specified location.


/SKIP_SC_MODELS:<listof model ID's>

A comma-separated list of QPR ScoreCard model ID's that are not writtento the export file.

ExampleQPR.TransferTool.exe /export_FILE /FILE:c:\76.dat /ds:QPR_76_ACCESS_DEMO /ds_user:user /ds_pwd:password /LOG:c:\log.txt


Import File

By starting QPR Transfertool with the /import_FILE parameter it is possible to import data from a fileinto a database.

Note that it is possible to overwrite an existing database using this parameter!

Parameters

/FILE:<location andname name of sourcefile>

Location and filename where the data is imported from.




Target database user's password.


The specific location and filename for the log created by Transfertool. Ifnot specified, Transfertool will write a log into the <path to all users

Appendices


profile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case ofWindows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1\Logs

/NOCONFIRM Do not ask for confirmations.

/DEBUG:<location andname name of log file>

Write a debug log file to the specified location.


/SKIP_SC_MODELS:<model ID's>

A comma-separated list of QPR ScoreCard model ID's that should not beimported to the database from the import file.

ExampleQPR.TransferTool.exe /import_FILE /FILE:c:\76.dat /dt:QPR_81_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt


Merge QPR ProcessGuide Attributes

By starting QPR Transfertool with the /MergePGAttributes parameter, you can merge duplicate customattributes in a model. Note: With Oracle, administrator rights are needed for performing thisoperation.

Parameters






The specific location and filename for the log created by Transfertool. Ifnot specified, Transfertool will write a log into the <path to all usersprofile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case ofWindows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1\Logs

ExampleQPR.TransferTool.exe /MergePGAttributes /dt:QPR_81_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt


Graph Layout Mass Operation

By starting QPR Transfertool with a /GRAPH_LAYOUT_MASS_OPERATION parameter, it is possible tomodify settings related to period or series for all graph layouts in the database. This operation is notmade during a database transfer, but is meant for doing changes to a database already at the currentversion. Before doing this operation, shut down all QPR servers.

Mandatory parametersWhen doing a graph layout mass operation, you must specify the target database with the /DT:parameter (and /DT_USER: and /DT_PWD: parameters if the database requires username andpassword for login).

Appendices


You must also use /MODEL: parameter to specify whether you want the modification to target allmodels or some individual model. The syntax is following:

/MODEL:ALL

or

/MODEL:<model id>

You cannot specify more than one individual model. If you want to do modifications to a set ofmodels, you must run Transfertool multiple times. Because the modification process loads all thetargeted layouts to memory, it might be wise to run the operation one model at a time for largedatabases.

You must also give one or both of the following parameters. They specify whether the operationtargets custom graph layouts and/or graph layout templates:/CUSTOM_LAYOUTS/TEMPLATES

Optional parameters/ONLY_INDICATORS If this parameter is given, then all the

modifications are done only to items of followingtypes: traffic lights indicator, icon indicator, lineargauge indicator, circular gauge indicator.

/ONLY_CHARTS If this parameter is given, then all themodifications are done only to items of followingtypes: history chart.

/SET_PERIOD:NONE|CURRENT|LATEST Sets the item's default period. Setting a specificperiod id is not supported. If this parameter is leftunspecified, the default period of the items is nottouched.

/SET_SERIES:NONE Sets the item's default series. Setting a specificseries is not supported. If this parameter is leftunspecified, the default series of the items is nottouched.

/SET_PERIOD_LOCK Sets the 'lock to default' option on for layoutitems' default period.

/CLEAR_PERIOD_LOCK Sets the 'lock to default' option off for layoutitems' default period.

/SET_PERIOD_LEVEL_LOCK Sets the 'lock to default' option on for layoutitems' default period level. In practice, this hasonly visible effects to items whose type is historychart.

/CLEAR_PERIOD_LEVEL_LOCK Sets the 'lock to default' option off for layoutitems' default period level. In practice, this hasonly visible effects to items whose type is historychart.

/SET_SERIES_LOCK Sets the 'lock to default' option on for layoutitems' default series. This has no effect to items oftype history chart.

/CLEAR_SERIES_LOCK Sets the 'lock to default' option on for layoutitems' default series. This has no effect to items oftype history chart.

Here are some examples of QPR Transfertool command line usage:

Appendices


QPR.TransferTool.exe /DT:"ACCESSDEMO" /GRAPH_LAYOUT_MASS_OPERATION /CUSTOM_LAYOUTS /TEMPLATES /MODEL:ALL /SET_PERIOD:CURRENT /SET_PERIOD_LEVEL_LOCK /ONLY_CHARTS

Sets the default period to current and period level lock on for all charts in all graph layouts in allmodels of the accessdemo database.

QPR.TransferTool.exe /DT:"ACCESSDEMO" /GRAPH_LAYOUT_MASS_OPERATION /CUSTOM_LAYOUTS /MODEL:1234567 /SET_PERIOD:NONE /SET_SERIES:NONE /CLEAR_PERIOD_LOCK /CLEAR_SERIES_LOCK

Sets the default period and series to none and period and series locks off for all layout items(indicators, charts, and other layouts items that use periods and series) in all custom graph layouts inthe model whose id is 1234567 in the Access demo database.

The transfertool log will report the number of layouts processed and any error messages.


Remove Dead Links from Actions

By starting QPR Transfertool with the /REPAIR_ACTION_PARENTS parameter, you can remove thoselinks in actions that point to QPR ScoreCard or QPR ProcessGuide objects which no longer exist in theused database.

Parameters






The specific location and filename for the log created by Transfertool. Ifnot specified, Transfertool will write a log into the <path to all usersprofile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case ofWindows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1\Logs

ExampleQPR.TransferTool.exe /REPAIR_ACTION_PARENTS /dt:QPR_81_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt

References


13 References

[1] QPR Software Plc web site, http://www.qpr.com/.[2] QPR Customer Care, contact information available at http://www.qpr.com/support/.[3] Adobe Systems Incorporated web site, http://www.adobe.com/[4] Microsoft Corporation web site, http://www.microsoft.com/[5] The Apache HTTP Server Project web site, http://httpd.apache.org/[6] Sniptools web site, http://sniptools.com/[7] QPR Developer's Guide, available on the QPR CD

http://www.qpr.com/

http://www.qpr.com/support/

http://www.adobe.com/

http://www.microsoft.com/

http://httpd.apache.org/

http://sniptools.com/

Acknowledgements


14 Acknowledgements

TPNGImage component provided by Gustavo Daud.

Portions of this software are Copyright (c) 1993 - 2003, Chad Z. Hower (Kudzu) and the Indy Pit Crew - http://www.IndyProject.org/

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the followingconditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimerin the documentation, about box and/or other materials provided with the distribution.No personal names or organizations names associated with the Indy project may be used to endorse or promote productsderived from this software without specific prior written permission of the specific individual or organization.

THIS SOFTWARE IS PROVIDED BY Chad Z. Hower (Kudzu) and the Indy Pit Crew "AS IS'' AND ANY EXPRESS OR IMPLIEDWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR APARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANYDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITEDTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, ORTORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software utilizes the ANTLR 3 parser generator, Copyright (c) 2003-2007, Terence ParrAll rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the followingconditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the followingdisclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the followingdisclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derivedfrom this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIEDWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR APARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FORANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOTLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, ORTORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Ninject assembly provided by Nate Kohari. Licensed under the Apache License 2.0.

http://www.opensource.org/licenses/apache2.0.php

QPR - Administrators Guide

Documents

Transcript of QPR - Administrators Guide