Professional Documents
Culture Documents
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 errors or omission of facts contained herein. QPR reserves the right to modify specifications cited in this document without prior notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or manual, for any purpose, without the express written permission of QPR Software Plc.
Contents
Table of Contents
1 1 Introduction ................................................................................................................................. 2 2 System Architecture .................................................................................................................................
2.1 Multiple QPR Systems on a Single Machine ............................................................................................................................. 3
Contents
5.2 Evaluating the Software ............................................................................................................................. 54 5.3 QPR License Policy ............................................................................................................................. 54
Transient Licenses ............................................................................................................................................................ 55 Transient Product Activation ............................................................................................................................................................ 56 License Types ............................................................................................................................................................ 56 License Usage Report ............................................................................................................................................................ 58
59 6 Activation Procedure ................................................................................................................................. 7 Installing QPR ScoreCard Integration 60 Kit ................................................................................................................................. 8 61 Configuring QPR Installation .................................................................................................................................
8.1 QPR Configuration Manager ............................................................................................................................. 61
Common Settings ............................................................................................................................................................ 61 Database Operations ............................................................................................................................................................ 63 Server Locations ............................................................................................................................................................ 63 Server Log Settings ............................................................................................................................................................ 64 Service Operations ............................................................................................................................................................ 65 System Migration ............................................................................................................................................................ 66 Versions ............................................................................................................................................................ 67 QPR ............................................................................................................................................................ 67 User Management Server Settings LDAP Settings ............................................................................................................................................................ 69 QPR ............................................................................................................................................................ 71 ScoreCard Server Settings QPR ............................................................................................................................................................ 72 ProcessGuide Server Settings QPR ............................................................................................................................................................ 73 Web Application Server Settings QPR ............................................................................................................................................................ 76 Portal Plugin Settings QPR ............................................................................................................................................................ 77 ProcessGuide Plugin Settings QPR ............................................................................................................................................................ 78 ScoreCard Plugin Settings
Contents
10
10.1 Dynamic Web Application Server ............................................................................................................................. 93 10.2 Static Web Publishing ............................................................................................................................. 93
Static Web Publishing with QPR ProcessGuide ............................................................................................................................................................ 93 Static Web Publishing with QPR ScoreCard ............................................................................................................................................................ 93
94 11 Maintenance .................................................................................................................................
11.1 Modeling Phase Routines ............................................................................................................................. 94
Daily Routines ............................................................................................................................................................ 94 Weekly Routines ............................................................................................................................................................ 94 Monthly Routines ............................................................................................................................................................ 95
Contents
14
Introduction
Introduction
QPR Server is the backbone of the QPR 8 software suite. The QPR Server is comprised of five individual server components: QPR User Management Server QPR ScoreCard Application Server QPR ProcessGuide Application Server QPR Web Application Server QPR 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 as information about the Windows Registry entries written by the QPR installation in Appendix B.
System Architecture
System Architecture
System Architecture
The QPR ProcessGuide Application Server is used for handling model operations and user management. The application server provides ProcessGuide content also to QPR Portal with the help of 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 2007 enabling 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 QPR products. This system is for the authentication of users, whereas the administering of specific rights to the users is performed separately with each QPR product. Users and groups can be managed from the QPR User Management Client. Therefore users and groups are not added with QPR ProcessGuide but with 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 different plugins (QPR Portal Plugin, QPR ProcessGuide Plugin, and QPR ScoreCard Plugin) running on the QPR Web Application Server. QPR Web Services Foundation QPR Web Services Foundation is a web services based open interface to all QPR information. It enables integration of third party systems and development of customized web applications utilizing QPR information. QPR Portal (Web Client) QPR Portal combines information from QPR Software products (QPR ScoreCard and QPR ProcessGuide) into one portal view, which contains the relevant information customized for each individual user's needs. QPR Portal Plugin is a dynamic link library, which uses a set of HTML templates 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
It is also possible to run many QPR Servers on the same computer. Having multiple instances of QPR Servers installed is also possible. See the instructions for having multiple versions installed simultaneously in Appendix C and follow them where applicable.
This chapter describes the requirements and recommendations for the different components of QPR 8.1.
3.1
Hardware Recommendations
The following hardware / operating system configurations are recommended to be used with various QPR 8.1 components. Note that these recommendations are based on a general case installation. The system may in fact require more or less hardware depending on the usage of the system.
2 GB 2 GB
-"-"-
QPR Servers
System Size OS CPU Memory 4 GB Disk Space 20 GB Other Requirements
Gigabit TCP/IP Network, Graphics card capable of 32bit colors & Database running on a separate system Note: These recommendations are for an implementation of a system with approximately 5 Designer users and 50 QPR Portal users. System Size OS CPU Memory Disk Space 100 GB Other Requirements Gigabit TCP/IP Network, Graphics card capable of 32bit colors &
Small QPR Windows 2 x Intel XEON 2GHz Implementation 2003 or 2008 (dual core) equivalent Server (x86) or faster
Large QPR Windows 2 x Intel XEON 2GHz 12 GB Implementation 2003 or 2008 (quad core) equivalent Server (x64) or faster
System Size
OS
CPU
Memory
Disk Space
Other Requirements
Database running on a separate system Note: These recommendations are for an implementation of a system with approximately 20 Designer 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 later Support for the following data types: Oracle: NUMBER, NVARCHAR2, RAW, NCLOB, BLOB, DATE SQL 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-Windows versions may also work, but the functionality cannot be guaranteed and you must verify the functionality by yourself in such cases. Your database must meet both the generic database requirements and the DBMS/edition requirements listed below. Database compatibility can be tested with the QPR Configuration Manager and it should be done every time a new database is taken into use. 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 supported by QPR. Database vendors may provide compatibility for alternative operating systems like Linux, UNIX, AIX, and HP9000. Contact your Database vendor and QPR to learn more about alternative operating systems. Note that only 32-bit ODBC drivers are supported with all supported databases. Database Management System Microsoft Access 2003 Microsoft Access 2007 Microsoft SQL Server 2005 Express Workgroup Standard Enterprise Express Edition Architecture Platform 32-bit (x86) 32-bit (x86) 32-bit (x86) 64-bit (x64) Microsoft Windows Microsoft Windows Microsoft Windows Additional Notes For standalone use only. For standalone use only.
32-bit (x86)
Microsoft
Edition Workgroup Standard Web Developer Enterprise Express Edition Personal Edition Standard Edition One Standard Edition Enterprise Edition Personal Edition Standard Edition One Standard Edition Enterprise Edition
Additional Notes
Microsoft Windows
Verify platform-specific installation, supported drivers, supported patch sets, and supported clients with QPR Customer Care Verify platform-specific installation, supported drivers, supported patch sets, and supported clients with QPR Customer Care
Microsoft Windows
Note about Oracle character sets: The national character set in Oracle must always be AL16UTF16, and the database character set must be AL32UTF8.
3.3
The following operating systems are supported by the different QPR components: Operating System Windows 7 Edition Applicatio Dev n Server / Client WAS X X Standalon Web e Client X X 32-bit 64-bit*
Windows 2008 Server Windows Vista Any (see notes after the list) Windows 2003 Server Windows 2003 Server R2 Windows XP Mac OS X Professional
X X
X X
X X
X X
X X
X X X
X X X
X X X
X X X
X X X
10.2.x or X later Note: Default web servers shipped with non-server versions of Windows may impose limits on the amount of concurrent users. E.g. Microsoft Windows XP Professional automatically imposes a 10connection limit on IIS. You cannot change this limit. Please verify the limits from the operating system 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 and may 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-bit mode. 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 Server Home Premium edition does not support Windows Integrated Authentication Business, 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 Server Home Premium edition does not support Windows Integrated Authentication Professional, Enterprise, and Ultimate editions support all features available in QPR 8.1
3.4
QPR Software certifies the following web servers: Web Server Apache Microsoft Internet Information Services Version 2.2.x 6.0 - 7.5 (only qpr.dll is supported on IIS 7.0 & 7.5)
With other servers the functionality must be separately tested or separately confirmed by QPR. Note that QPR Web Services Foundation is supported only on Microsoft Internet Information Services.
menu 4. 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 Extensions 1. Go to Start Menu -> Programs -> Administrative Tools -> Internet Information Services (IIS) Manager. 2. Expand the Server name and the Web Service Extensions sections 3. 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 for SVG 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 type mappings for file types used by Silverlight and add them if necessary. To add the mappings, 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 .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-app Extension: .xbap, MIME type application/x-ms-xbap 7. Click OK and restart the website Additional configuration in 64-bit edition In order to run qpr.dll you must configure IIS 6.0 to run 32-bit applications on a 64-bit Windows. To do 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 dont have to set the IIS 6.0 to run 32-bit applications.
5. 6.
CGI Path field. Input a description for the extension and check the "Allow extension path to execute" checkbox. Click the OK button.
In order for SVG views to work properly, you need to verify that there is a MIME type mapping for SVG 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. 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 type mappings for file types used by Silverlight and add them if necessary. To add the mappings, do the following: 1. Go to Start Menu -> Control Panel -> Administrative Tools -> Internet Information Services (IIS) Manager. 2. Select Default Web Site. 3. Open the MIME Types section. 4. If .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-app Extension: .xbap, MIME type application/x-ms-xbap 6. Click OK and restart the website Additional configuration in 64-bit edition In order to run qpr.dll you must enable 32-bit applications in IIS 7.0 / 7.5. The settings are done in the same way as in 32-bit environment (see System Requirements.pdf for normal settings). In addition, 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
There are two alternative ways of utilizing web publishing. CGI binary application for Windows platforms. This works with all supported web servers except for IIS 7 and IIS 7.5. ISAPI DLL for Windows platforms and Microsoft Internet Information Services (IIS). This is a recommended choice if you are running IIS as the ISAPI DLL performs faster than the CGI binary.
10
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.). CGIbinary 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 Server installation. Note that plugin-specific contents must be separately installed to web server computer, if plugins used require 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. The settings are: Host IP is the TCP/IP address of the computer where QPR WAS is installed (127.0.0.1 refers to the local computer). Host Port is the socket port number used by WAS, default value is the same as in WAS installation. The settings are saved in qprsettings.dat file.
3.5
The following web browsers are compatible with QPR Portal: Web Browser Microsoft Internet Explorer Mozilla Firefox for Windows Mozilla Firefox for Linux and Mac OS X Version 6.0, 7.0, 8.0 3.0, 3.5 3.0, 3.5
Note: Using Mini Portal in Microsoft Internet Explorer 6 is not recommended due to performance issues and the limited support of CSS 2.1 in Microsoft Internet Explorer 6. Note: Mini Portal is not supported with Right-to-Left Languages.
11
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 browserindependent 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-in SVG 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 false 3. 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 Other Requirements section. 4. Restart Mozilla Firefox
Browser Configuration
Usually default settings are correct, i.e. no separate configuration is needed. However the following settings may need attention: Browser must allow execution of JavaScript and JavaScript must be allowed to perform the following functions: Open new windows Resize and move windows In some cases, a pop-up blocker may interfere with QPR Portal. It is advisable to add QPR Portal as a whitelisted (allowed) site which can open windows freely in the case a whitelisting possibility exists. Depending on contents browsed through QPR Portal, it may be advisable to set the 'Empty page history' setting on. 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 the case you are using a web server running on some other platform than Windows.
3.6
Other Requirements
SVG Requirements
QPR 8.1 supports the Adobe SVG Viewer versions 3.01 - 3.03. See the table below for notes about browser compatibility: Browser Microsoft Internet Explorer Supported Versions 3.03
12
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 browser compatibility: Browser Supported Versions
Microsoft Internet Explorer 6 3.0 Microsoft Internet Explorer 7 3.0 Microsoft Internet Explorer 8 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 for Microsoft Office 2007. If you select either of the features to be installed and you do not have the framework installed, it is installed during the QPR 8 installation. However, the .NET Framework installation requires an Internet connection, so without a connection you need to acquire the framework by other means. If you wish to install the framework before installing QPR 8, you can acquire it from http://www.microsoft.com/downloads/details.aspx?FamilyID=333325FD-AE52-4E35B531-508D977D32A6&displaylang=en. Microsoft .NET Framework 2.0 or later is required for using QPR ScoreCard Designer and QPR Web Application Server. QPR 8 installation will install Microsoft .NET Framework 2.0 SP2 if it is not present on the computer and QPR ScoreCard Designer and/or QPR Web Application Server is selected to be installed.
Office Requirements
Using the QPR Add-In for Microsoft Office 2007 requires Microsoft Word 2007 and Visual Studio Tools for Office runtime 3.0 SP1. The VSTO runtime as well as Office 2007 Primary Interoperability Assemblies are installed during the QPR Add-In for Microsoft Office 2007 installation in the case they are not present on the machine.
VB Script Requirements
In the case Visual Basic Scripting (VBScript) is used, the supported version is 1.0.
OLAP Requirements
With OLAP (Online Analytical Processing), only Microsoft SQL Server is supported.
LDAP Requirements
13
If LDAP (Lightweight Directory Access Protocol) is used for authentication, the following implementations are supported: Windows Active Directory OpenLDAP 2.3
Localization Requirements
In multilingual environments you may need to install additional fonts to computers running QPR ProcessGuide Designer and/or QPR ScoreCard Designer. On Windows Vista and newer systems the necessary fonts are usually installed by default, but on Windows XP you may need to install additional fonts. This can be done in Control Panel -> Regional and Language Options -> Languages -> Supplemental language support. Note that you will have to reboot the computer after installing the additional language support files.
The system requirements provided herein do not extend to situations where a defect or an error has been recognized in a third party vendor software product listed herein as a supported product. Such errors are e.g. all errors that the third party vendor has acknowledged by releasing a service pack or a new version addressing the issue, or errors which are in some other way publicly acknowledged by the vendor.
14
Most QPR products are installed with one single installation package, which allows an easy and straightforward installation. The installation requires that Windows Installer 3.1 (all supported versions of Windows prior to Windows Vista) is installed. Every later version of Windows has a required Windows Installer version installed out of the box. In the case you do not have the Windows Installer engine installed or you have an older version, please acquire a supported version from Windows Update. In addition, MDAC 2.7 or newer is required for the installation. Some preparations need to be done before starting the actual installation. See the Preparations chapter 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 read through this section carefully to ensure that your system environment is ready for QPR 8 installation.
4.1.1
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 4.1.2.1
In order to perform the QPR 8 installation you need to have administrative privileges in Windows. Also make sure that you have an adequate amount of free hard disk space. See the System Requirements section for information about the required amount.
4.1.2.2
Install Databases
QPR products use DataBase Management Systems (DBMS) for administrating users and storing user and model data. The primary requirement for the database server is that it needs to be an SQL DBMS with an Open DataBase Connectivity (ODBC) interface. You can use any DBMS which conforms to these requirements, but the installation will be the most convenient when one of the directly supported DBMSes is used. When you have decided upon the database server, install and configure the DBMS. For installation instructions, please select the instructions according to your DBMS:
15
16
Create and configure a database for QPR products. All QPR products use a single database instance, so you need to create and configure only one database for the whole system. Please consult your Oracle manual for instructions on creating a new database. A minimum QPR database should work fine with the default database configurations. However, make sure that there is enough hard drive space allocated for the database tablespace as well as the transaction log. They both should have space for at least 100 MB of data. With larger amounts of data the allocations and database settings most probably need to be adjusted. You can test your database configuration by clicking the Test Database Configuration button at the Database tab of the Common section in the QPR Configuration Manager utility, which can be found at the Utilities folder under your QPR 8.1 installation folder. Verify also that there is an ODBC data source configured for the database and configure it if needed. In 64-bit Windows environments, the data sources configured with the ODBC Data Source Administrator available in the Control Panel cannot be seen in QPR Configuration Manager. To be visible, the data source must be configured with "odbcad32.exe", which can be found in C:\WINDOWS\SysWOW64.
4.1.2.3
Web Server
In order to use QPR Portal, you need to have a web server software configured before installing QPR 8.1. See the System Requirements chapter for information about supported web servers and consult the server's installation instructions for information about its installation.
17
4.1.2.4
User Directory
QPR 8 utilizes QPR User Management System for user rights administration. QPR User Management System supports also user imports from NT domain and LDAP servers as well as Integrated Windows Authentication (IWA). Before making the installation it is advisable to plan how user rights for QPR products are managed and acquire required rights to e.g. active directory servers.
4.1.2.5
Hardware
Check the System Requirements chapter and verify that your hardware is adequate for running QPR 8.
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 some additional dependencies: Microsoft .NET Framework 3.5 SP1 runtime for both features Visual Studio Tools for Office (VSTO) 3.0 SP1 runtime and Office 2007 Primary Interoperability Assemblies for QPR Add-In for Microsoft Office 2007 All of these requirements are included in the QPR 8 installation package and installed if the corresponding features are selected to be included in the installation, but you might consider installing these components before the QPR 8 installation in the following cases: Bandwidth usage is a concern or you are installing the suite on multiple workstations. Due to the size of the full runtime, the QPR 8 package includes only an installer bootstrapper which fetches the rest of the framework from the Microsoft web site. Distributing the framework internally within your organization before QPR 8 installation eliminates the need for separately fetching the framework to all target workstations. You want to reduce time required to install QPR 8 You want to install QPR 8 silently (VSTO runtime installation does not run silently when launched from the QPR 8 package). Note that in order for the QPR Add-In for Microsoft Office 2007 to work properly, the Office 2007 installation needs to have the Visual Basic for Applications feature installed (found in the Office Shared Features 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 Web Services Foundation and QPR Add-In for Microsoft Office (available only if Microsoft Word 2007 is detected on the computer) can be added to the installation but they are not included by default. In the Additional Tasks dialog you can define whether the installation should work in a standalone mode.
18
QPR ProcessGuide and QPR ScoreCard Designers: With this option you can install QPR ProcessGuide Designer and/or QPR ScoreCard Designer and optionally also QPR Add-In for Microsoft Office. No server components are included in this setup type. Custom (for advanced users only). With this option you can customize the component selection freely. The following options are available for the custom installation: QPR 8.1 - Clients QPR User Management Client QPR ScoreCard Designer QPR ProcessGuide Designer QPR Add-In for Microsoft Office (not selected by default, available only if an Office 2007 installation 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 Scripts QPR 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 the following 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 the QPR Add-In for Microsoft Office 2007. In addition to the .NET Framework, the QPR Add-In for Microsoft Office 2007 requires the VSTO 3.0 runtime to be installed. These additional requirements are installed to your computer if you select the installation options that require them. The additional installations take place after the "Ready to Install" step right before copying the QPR 8.1 files. Note that the Typical installation option excludes the QPR Add-In for Microsoft Office 2007 and QPR Web Services Foundation, so you need to use the Custom setup in order to include them. Also note that QPR 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 Web Application Server. QPR 8 installation will install Microsoft .NET Framework 2.0 SP2 if it is not present on the computer and QPR ScoreCard Designer and/or QPR Web Application Server is selected to be installed. QPR FactView is not part of the standard QPR installation package but it is installed separately. For instructions 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 Instructions Install only Designer components and/or QPR Add-in for Microsoft Office: Go to Designer Installation Instructions Freely define the selection of components: Go to Custom Installation Instructions
19
4.2.1
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 in the license agreement" and click Next to continue in the case you accept the license terms. Otherwise you'll need to cancel the installation.
20
11. Configuration
Before the end of the installation, QPR Configuration Manager appears so that you can verify your
21
settings. However, in the case you had the Standalone option selected, the QPR Configuration Manager is not displayed.
12. Complete
The installation is now complete. Check the "Activate the software now" checkbox if you wish to launch the QPR Product Activation Wizard after clicking Finish. Similarly, checking the "Show the readme file" checkbox opens the readme file after you click Finish. In addition, if a QPR 7.6 or a QPR 8.0 installation was found on the computer, there is also a "Launch the Migration Utility" option available on the last page. Selecting that will open QPR Configuration Manager into the System Migration section after clicking Finish. If you have multiple options selected, the corresponding operations are performed one at a time, i.e. the readme file is displayed after finishing the activation and the migration utility is not launched before the readme file is closed.
4.2.2
Designer Installation
Follow the instructions below to install QPR ProcessGuide Designer and/or QPR ScoreCard Designer and optionally also QPR Add-In for Microsoft Office:
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 in the license agreement" and click Next to continue in the case you accept the license terms. Otherwise you'll need to cancel the installation.
22
8. Ready to Install
The installer is now ready to start copying the application files to the computer. If you need to change any settings, click Back and make the necessary changes. Once you are satisfied with the settings, click Install to start the installation.
9. Complete
The installation is now complete. Check the "Activate the software now" checkbox if you wish to launch the QPR Product Activation Wizard after clicking Finish. Similarly, checking the "Show the readme file" checkbox opens the readme file after you click Finish.
23
4.2.3
Custom
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 in the license agreement" and click Next to continue in the case you accept the license terms. Otherwise you'll need to cancel the installation.
5. Select Features
Select the features that will be installed. You can also change the destination folders here for various components. However, all features except for QPR Portal Scripts and QPR Portal Web Contents use the same destination folder, so changing the destination folder for one of the features affects the others as well. It is advisable to leave the QPR Portal Scripts and QPR Portal Web Contents destination folders to their default values in this dialog, as their locations will be determined in the forthcoming dialogs. Once you have the desired set of features selected, click Next to continue.
24
25
11. Configuration
Before the end of the installation, QPR Configuration Manager appears so that you can verify your settings. However, in the case you had the Standalone option selected, the QPR Configuration Manager is not displayed.
12. Complete
The installation is now complete. Check the "Activate the software now" checkbox if you wish to launch the QPR Product Activation Wizard after clicking Finish. Similarly, checking the "Show the readme file" checkbox opens the readme file after you click Finish. In addition, if a QPR 7.6 or a QPR 8.0 installation was found on the computer, there is also a "Launch the Migration Utility" option available on the last page. Selecting that will open QPR Configuration Manager into the System Migration section after clicking Finish. If you have multiple options selected, the corresponding operations are performed one at a time, i.e. the readme file is displayed after finishing the activation and the migration utility is not launched before the readme file is closed. For information about further customization possibilities, see the Silent and Customized Installations section.
4.2.4
Service Installation
QPR Server components (i.e. both Application Servers, the QPR User Management System, and the QPR Web Application Server) can be installed as service on Windows XP, Windows 2003, Windows Vista, and Windows Server 2008. In the case you are installing one of more QPR server components and you have selected service to be installed, the QPR Service installation will be performed after the files are installed. The QPR Service controls all QPR 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 you want the service to be started during Windows start-up. If you need more configuration options regarding the service such as installing it with a different name or creating service dependencies, please install the service from the command line after the installation. See the instructions below for more information.
Service Installation Using Command Line Parameters Service can be installed and uninstalled with command line parameters as well. With the command line installation option you can install the service later on even if you have decided not to install it during the QPR 8.1 installation. The installation/uninstallation is done by launching the QPR.Init.exe in the 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 starts service installation for the QPR Service 8.1. -d for uninstalling the service. For example, launching 'qprinit.exe -d' in the Utilities folder uninstalls the QPR Service 8.1.
26
4.2.5
Configuration Suggestions
This section provides information on suggested configuration for selected scenarios where the default configuration is not optimal. Right-to-left Languages When running QPR Portal in right-to-left languages such as Arabic, the following configuration should be done: Use Microsoft Silverlight instead of Adobe SVG Enable the "Use bitmap text in graphical views" setting in the QPR Web Application Server -> QPR ScoreCard Plugin section.
4.2.6
Use the checklists below (pick the one that is applicable) to verify that your QPR system is properly installed and configured on a basic level. Note that the checklists below are for reference purposes and they do not take into account any environment-specific settings. Use this list if you selected the standalone option. # Task Expected Output 1 Start QPR ProcessGuide The application is started Designer successfully. 2 3 4 5 6 7 Open a server model in QPR ProcessGuide Start QPR ScoreCard Designer Open a model in QPR ScoreCard Start QPR Web Application Server Launch QPR Portal Browse QPR ProcessGuide and QPR ScoreCard Models in Portal Access http://localhost/ QPR81WebServices/ servicetester.aspx and click QueryObjectsAsXml Launch Microsoft Word 2007 Model is opened without errors. The application is started Also QPR ScoreCard Server is successfully. started Model is opened without errors. QPR Web Application Server is started successfully. Login is successful. All models are displayed You may need to install an SVG successfully. plugin or Microsoft Silverlight first in order to view some QPR ScoreCard views. The tester is launched * Applicable only if you installed successfully and clicking on QPR Web Services Foundation. QueryObjectsAsXml returns a result set with multiple objects The QPR tab appears in Word. * Applicable only if you installed QPR Add-In for Microsoft Office.
Notes Also QPR User Management Server and QPR ProcessGuide Server are started
27
Use this list if you selected to install service or omitted both standalone and service options. # Task Expected Output Notes 1 If you installed QPR Service, The service is started start the service. Otherwise successfully or all server start all QPR servers (QPR components are started User Management Server, successfully. QPR ScoreCard Server, QPR ProcessGuide Server, and QPR Web Application Server) 2 Open a server model in QPR Model is opened without errors. ProcessGuide 3 Start QPR ScoreCard The application is started Designer successfully. 4 Open a model in QPR Model is opened without errors. ScoreCard 5 Launch QPR Portal Login is successful. 6 Browse QPR ProcessGuide All models are displayed You may need to install an SVG and QPR ScoreCard Models successfully. plugin or Microsoft Silverlight first in Portal in order to view some QPR ScoreCard views. 7 Access http://<hostname>/ The tester is launched * Applicable only if you installed QPR81WebServices/ successfully and clicking on QPR Web Services Foundation. servicetester.aspx and click QueryObjectsAsXml returns a QueryObjectsAsXml result set with multiple objects 8 Launch Microsoft Word 2007 The QPR tab appears in Word. * Applicable only if you installed QPR Add-In for Microsoft Office.
4.2.7
Follow the instructions in the following sections to install QPR 8.1 silently or to customize an installation with the graphical user interface included.
4.2.7.1
To perform a silent installation equivalent to the typical installation with the default settings, open the command prompt to the folder containing the QPR8Setup.exe package and start the installation with the 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 (see the Task Manager) anymore, you can start using the software. See the next section for information about how to customize e.g. the selection of software components included in the installation.
28
4.2.7.2
Customized Installation
To customize the silent installation, you can supply some of the public properties listed below to customize the behavior of the silent installation. The base command required in all cases is QPR8Setup.exe /s /v"/qn followed by a selection of properties listed below. Remember also to add a closing double quote after defining the properties you want. In addition, make sure that there are no spaces in the /v"/qn part to ensure correct functionality. Note that you can also supply the properties to an normal (i.e. not silent) installation. In that case, omit the /s and /qn options from the base command. In addition, if any properties require values that need to be enclosed in double quotes, you need to escape those double quotes with a preceding backslash to avoid prematurely terminating the string supplied to the /v option. Example: 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 preconfigured 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 used when the actual settings file created into C:\ProgramData\QPR Software\QPR 8\8.1\Settings in Windows Vista and later versions and <path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\Settings in earlier versions of Windows. However, the file may not get copied properly in the case 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 the installation. Note that only one PRODUCTACTIVATION option can be selected for an installation, so this property cannot coexist with PRODUCTACTIVATION=2 or PRODUCTACTIVATION=3. PRODUCTACTIVATION=2: Activates a 14-day evaluation license (if allowed) silently at the end of the installation. PRODUCTACTIVATION=3: Performs a silent activation at the end of the installation provided that there's a properly filled qpr.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 in the case you are using some other web server software and you are having problems with the installation. NOSERVICE=1: Skips the QPR Service installation. The service is installed by default on server editions of Windows, so you can use this option in the case you want to install the service manually after a silent installation on for instance Windows Server 2003/2008. ASKSCRIPTFOLDER=1: Requests for the script/CGI-binary folder also when Microsoft IIS is found on the computer. This can be used also in non-silent installation to provide additional control. Example 1: Install QPR 8.1 silently and activate an evaluation license: QPR8Setup.exe /s /v"/qn PRODUCTACTIVATION=2" In the case you want to customize the selection of features installed within a silent installation similarly as you could do in the Select Features dialog in the Custom installation, you can do so by lowering the installation level below the default (100) and adding the desired features using the ADDLOCAL property. Feature names: PGDevelopmentClient: QPR ProcessGuide Designer SCDevelopmentClient: QPR ScoreCard Designer UserManagementClient: QPR User Management Client QPRAddInForOffice2007: QPR Add-In for Microsoft Office 2007. Requires Microsoft .NET Framework 3.5 SP1, VSTO runtime 3.0 SP1 and Office 2007 Primary Operability Assemblies. All of these prerequisites are installed during the QPR 8.1 installation if QPR Add-In for Microsoft Office 2007 is selected to be installed and the prerequisites are not installed. SCApplicationServer: QPR ScoreCard Server PGApplicationServer: QPR ProcessGuide Server UserManagementServer: QPR User Management Server
29
WASAndPlugins: QPR Web Application Server. WASScripts: QPR Web Application Server Scripts (CGI scripts and binaries and ISAPI DLL) WASWebContents: QPR Web Application Server Web Contents WASWebServices: 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 be installed and the framework cannot be found on the computer. PGDesktopIcon: Desktop icon for QPR ProcessGuide SCDesktopIcon: Desktop icon for QPR ScoreCard PortalDesktopIcon: Desktop icon for QPR Portal WLTShortcut: Start menu shortcut for QPR Product Activation ConfigShortcut: Start menu shortcut for QPR Configuration Manager To define installation location for these, provide values to the INSTALLDIR (all features except for WASScripts 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 you define a value for CGI and vice versa. For Microsoft IIS the value is set to be "Scripts" under the folder 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) as well as QPR Web Application Server and necessary scripts and web contents to defined locations and launch the product activation at the end of the installation: QPR8Setup.exe /s /v"/qn INSTALLLEVEL=10 ADDLOCAL=SCDevelopmentClient,SCDesktopIcon,WASAndPlugins, WASWebContents,WASScripts INSTALLDIR=\"C:\Program Files\QPR 8 Custom\" WASWEB=\"C:\inetpub\wwwroot\qpr81\" PRODUCTACTIVATION=2"
4.2.8
This section guides you through installing the standalone MSI package of QPR ProcessGuide. The installation requires that you have at least version 2.0 of the Windows Installer engine (which can be obtained through Windows Update). Note that you should not install this package if you're using other components of the QPR 8.1 suite. In
30
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 ProcessGuide Designer 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 QPR ProcessGuide 8.1 installation. Click Next to continue.
2. License Agreement
Here you can see the End User Software License terms for the software that is about to be installed. You will need to accept these terms before continuing the installation. Select "I accept the terms in the license agreement" and click Next to continue in the case you accept the license terms. Otherwise you'll need to cancel the installation.
31
4. Customer Information
Here you need to define the customer information and select whether the application is installed for all users or only for yourself. Technically this setting controls whether the Start menu and desktop shortcuts are copied to the common profile or to your personal profile. Click Next to continue.
6. Ready to Install
The installer is now ready to start copying the application files to the computer. If you need to change any settings, click Back and make the necessary changes. Once you are satisfied with the settings, click Install to start the installation.
32
7. Installation Complete
The installation is now complete, and you can start 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 to continue. 2. License Agreement: Here you can see the End User Software License terms for the software that is about to be installed. You will need to accept these terms before continuing the installation. Select "I accept the terms in the license agreement" and click Next to continue. 3. Customer Information: Here you need to define the customer information and select whether the application is installed for all users or only for yourself. Technically this setting controls whether the 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 is located. In case the installer can successfully locate the existing installation, controls for changing the path are disabled. 5. Ready to Install: The installer is now ready to start copying the new application files to the computer. 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 ProcessGuide Xpress. Note that you need to reactivate the product after an upgrade.
4.2.8.4
Follow the instructions in the following sections to install QPR ProcessGuide silently or to customize an installation with the graphical user interface included.
33
34
[WLT Customer Info] CustomerCode=<valid customer code> Email=<valid e-mail> FirstName=<name> LastName=<name> Country=<country>
4.2.9
QPR FactView is not part of the standard QPR installation package. QPR FactView Server installation can be performed off CD media or from a disk file. To install QPR FactView Server, insert the CD in a drive 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) is used as the web server. Note: If the required Microsoft .NET 2.0 Framework is not installed, it will be included as part of the QPR 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, run QPRFVLauncher.exe manually from the root of the CD. 2. Select the QPR FactView Server option in the launcher. The QPR FactView Server installation program 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, run QPRFVLauncher.exe manually from the root of the CD. 2. Select the QPR Portal Interface option in the launcher. The QPR FactView Portal Interface installation 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.
35
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 "Enable link 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 QPR FactView, contact QPR Customer Care.
4.3
While the QPR 8.1 installation does recognize a QPR 7.6 or a QPR 8.0 installation, an upgrade similar to 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 the default settings QPR 7.6/8.0 installation is not overwritten (provided that also QPR 7.6/8.0 was installed to default folders). If QPR 7.6/8.0 is detected on the computer, there is a possibility to launch the migration utility at the end of the QPR 8.1 installation. With the help of the migration utility you can transfer your old settings and database from QPR 7.6/8.0 easily. For more information for performing the migration, see the System Migration section in QPR - Configuration Instructions document. Some issues to note: The default communication ports are the same in both versions, so when installing QPR 8.1 side-byside with QPR 7.6/8.0, you either need to run only one version at a time or change the ports the other version is using Only one version can be registered for QPR scripting at a time. You may need to manually register the desired version by running QPR.PG.Client.exe /regserver or QPR.SC.Client.exe /regserver (note that the exe names were proguide.exe and scclient.exe respectively on versions up to the initial release 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 transfer also QPR 7.5 databases with the database transfer functionality. Other settings need to be transferred manually. See the table below for reference. Customizations to QPR Portal templates do not get transferred automatically by the migration utility. 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 the display settings defined for the measurement unit. In QPR 8.0 and earlier the values were rounded to the nearest half or full number. This may have a severe display impact on elements which use units 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 (previously done in the 'Select Properties and Custom Attributes' dialog in QPR ProcessGuide) has been removed from the user interface in QPR 8.1. The visibility can now be controlled by editing the web templates. Settings for QPR Portal default views are stored in qpr.ini, so also settings should be migrated (or the 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 Database X
36
X -
4.3.1
The custom stylesheet structure of the QPR package makes it easier to import old Portal customizations to the new version when upgrading the QPR suite. For instructions concerning the customization itself, refer to the QPR Developer's Guide. Provided that you have inserted all your modifications to the custom.css file, you will only need to copy your changes from the old custom.css file into the current custom.css file under the qprsoftware/ stylesheets/custom.css folder. Copy also your customimages folder in the case you had any customized images in use. Do not overwrite the existing custom.css file as there can be some new styles included in the new file. Copy only your existing customizations to the matching classes. Note also that the web content folder structure has changed a bit between QPR 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 content directories. See below for details about the changes. In addition, templates from an earlier version are unlikely to work as such in a newer version, so when upgrading for example from QPR 7.6 to QPR 8.1, the old templates folder should not be dropped into the new installation as such, but the customizations should be ported instead. Porting means that the differences between the original QPR 7.6 templates and new QPR 8.1 templates are analyzed and customizations ported where applicable or necessary. QPR WAS and Portal Templates See the tables below for information about where QPR Portal templates are located in different versions so that you can properly port any customizations you might have in your templates. Briefing Booklet templates Version Folder location 7.5 7.6 <QPR 7 installation root>\Web Application Server\Templates\Booklet <path to All Users profile>\Application Data\QPR Software\QPR 7 \7.6\Templates\WAS\Booklet Note: Templates are initially installed to <QPR 7 installation root>\Web Application Server\Templates\Booklet, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. 8.0 <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.0\Templates\WAS\Booklet Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\Booklet, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates.
37
Version 8.1
Folder location <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.1\Templates\WAS\Booklet Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\Booklet, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates.
Common templates Version Folder location 7.5 7.6 <QPR 7 installation root>\Web Application Server\Templates\Common <path to All Users profile>\Application Data\QPR Software\QPR 7 \7.6\Templates\WAS\Common Note: Templates are initially installed to <QPR 7 installation root>\Web Application Server\Templates\Common, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. 8.0 <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.0\Templates\WAS\Common Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\Common, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. 8.1 <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.1\Templates\WAS\Common Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\Common, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. Portal templates Version Folder location 7.5 7.6 <QPR 7 installation root>\Web Application Server\Templates\Portal <path to All Users profile>\Application Data\QPR Software\QPR 7 \7.6\Templates\WAS\Portal Note: Templates are initially installed to <QPR 7 installation root>\Web Application Server\Templates\Portal, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions)
38
Version 8.0
Folder location location, so all customizations should be made to those templates. <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.0\Templates\WAS\Portal Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\Portal, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates.
8.1
<path to All Users profile>\Application Data\QPR Software\QPR 8 \8.1\Templates\WAS\Portal Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\Portal, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates.
SC templates Version Folder location 7.5 7.6 <QPR 7 installation root>\Web Application Server\Templates\SC <path to All Users profile>\Application Data\QPR Software\QPR 7 \7.6\Templates\WAS\SC Note: Templates are initially installed to <QPR 7 installation root>\Web Application Server\Templates\SC, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. 8.0 <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.0\Templates\WAS\SC Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\SC, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. 8.1 <path to All Users profile>\Application Data\QPR Software\QPR 8 \8.1\Templates\WAS\SC Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\SC, but they are copied to the path indicated above during the first startup and used from the All Users profile (ProgramData folder in Vista and later versions) location, so all customizations should be made to those templates. PG templates Version Folder location 7.5 <QPR 7 installation root>\Web Application Server\Templates\PG (Basic, Frames, and No Frames folders are now found only under QPR 7\ProcessGuide\WebLayouts
39
Version 7.6
Folder location <path to All Users profile>\Application Data\QPR Software\QPR 7 \7.6\Templates\WAS\PG Note: Templates are initially installed to <QPR 7 installation root>\Web Application Server\Templates\PG, but they are copied to the path indicated above during the first startup and used from the All 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 No Frames) are located under <path to All Users profile>\Application Data\QPR Software\QPR 7\7.6\Templates\PGStatic.
8.0
<path to All Users profile>\Application Data\QPR Software\QPR 8 \8.0\Templates\WAS\PG Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\PG, but they are copied to the path indicated above during the first startup and used from the All 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 No Frames) are located under <path to All Users profile>\Application Data\QPR Software\QPR 8\8.0\Templates\PGStatic.
8.1
<path to All Users profile>\Application Data\QPR Software\QPR 8 \8.1\Templates\WAS\PG Note: Templates are initially installed to <QPR 8 installation root>\Web Application Server\Templates\PG, but they are copied to the path indicated above during the first startup and used from the All 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 No Frames) are located under <path to All Users profile>\Application Data\QPR Software\QPR 8\8.1\Templates\PGStatic.
Note: During upgrades between different releases of QPR 8.1 (for example 8.1 and 8.1 SP1) the old template 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 the qprsoftware/stylesheets/customimages folder. Doing this ensures that the future upgrades will be simple, as you will only need to copy the styles in the custom.css stylesheet and the customimages folder to the new installation folder. It is also good to mark all customizations with easily searchable comments to make it easier to transfer them into a new version.
40
4.4
Modify
You can use the modify installation to add or remove installed features after the actual QPR 8.1 installation. To modify your selection of installed features, follow the instructions below: 1. 2. 3. 4. 5. 6. Go to Control Panel -> Add or Remove Programs. Select QPR 8.1 from the list and click the Change button. Click Next in the Welcome dialog. Select the Modify option and click Next. The Custom Setup screen opens. Select the features you want to have installed or removed, and click Next. 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 desktop shortcuts to be installed to prevent the desktop shortcuts from being removed during the modification. Leaving the service option unchecked removes the QPR Service and comparatively enabling the service option installs QPR Service. 7. The Ready to Modify the Program screen opens. If you need to change any settings, click Back and make the necessary changes. Once you are satisfied with the settings, click Install to start the installation. At this point you may be requested to browse the original QPR8Setup.exe file (i.e. the one you originally installed the software from) when adding QPR Web Services Foundation and/or QPR Add-In for Microsoft Office to the installation. This is needed so that the installation program can extract and install additional dependencies that the aforementioned components need in order to function properly. 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 your computer.
8.
4.5
Uninstallation
During uninstallation, the 8.1 folder under the common application data (C:\ProgramData\QPR Software in Windows Vista and later versions and C:\Documents and Settings\All Users\Application Data\QPR Software in older versions of Windows) is copied to 8.1_old (or old1...oldN in the case more backup folders exist), and you're asked whether you want to remove the folder. In the case you have any customizations or you have used the example Access database, it is safer to answer No and delete the old settings only after you've checked that you have all the material you want to keep with you. Note: If you are using QPR Web Services Foundation, it is recommended to either restart the computer or run iisreset before the uninstallation to make sure that there are no processes keeping the installation directory reserved.
41
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 components won't start. A: Both QPR 8 and QPR 7 servers use the same default ports, so in the case you have e.g. QPR 7 running as a service in the background, the ports are already in use, and you must either shut down the 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 start anymore. A: Launch QPR Product Activation Wizard to see your product activation status. Note that a Modify installation won't require reactivation unless you install some previously uninstalled items that require activation. Even if this is not the case, your transient product activation might have expired. If the product activation status is correct, launch the QPR Configuration Manager and go to the Database operations section. See that the data source is correct. Click the Test button to test your database configuration. Q: I'm using QPR with Oracle in a 64-bit Windows environment, and despite having a 32-bit ODBC data 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 installation path (C:\Program Files (x86)\QPR 8.1) contains parentheses in the path name and Oracle cannot handle them properly. To avoid this problem, install QPR to a folder that's not located under the Program Files (x86) folder. NOTE: Switching to the "regular" Program Files folder in 64-bit systems does 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.
42
QPR Product Activation is a system to make the installation and implementation of QPR products flexible and easy. QPR Product Activation consists of Product Activation Server and Product Activation Wizard (QPR.WLT.exe). QPR Product Activation Server records all activation transactions and provides reports of the aforementioned transactions, i.e. the QPR Product Activation Wizard takes care of the product activation process at the client side. Term 'product activation' is used instead of 'licensing' when organizations install QPR Products. To make things more clear, term 'License' refers to Agreement between organization and QPR Software Plc. about which product(s), how many users and for what time period the organization may use the product legally. Term 'product activation' refers to process with supporting system that is used to activate installed QPR Product. It is organizations' responsibility to control that activated products adhere 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 the activated product until expiration date. After license expiration date the Organization must renew the License Agreement. Transient License with fixed expiration time Organizations can use and fully utilize the product for a fixed time period after activation. After activation expiration date the Organization must 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 Internet connections. Licenses allow QPR products to be activated. Activation supports three different methods: Automatic Product Activation via Web Organization can activate the product automatically over the Internet and start using the software immediately. Manual Product Activation via Web - Organization can activate the product using their default 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 is connected to Internet. Manually via Phone/email Organization can activate the product by calling or e-mailing to QPR Customer Care. Manual product activation via Web differs from automatic product activation only so that default browser is used for communicating with the QPR Activation Server. QPR Product Activation Wizard generates a small HTML file that is opened with the default browser to POST activation information to server. 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 encrypted messages to communicate with the QPR Product Activation Server. QPR Product Activation Wizard also supports reactivating transient licenses silently. QPR 8.1 Product Activation supports all above-mentioned license types and two types of software evaluations: Built-in 14-day evaluation period Organization can activate a 14-day evaluation once per workstation 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 License Policy section. All QPR maintenance customers will get a Product Activation Code that must be used when products are activated. With a valid Product Activation Code, an organization can activate every QPR software for as many users as needed.
43
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 a Server installation is done. Development Client installation is done. Number of registered users in the User Management System exceeds the number of activated users For the abovementioned tasks you need to have a valid Product Activation Code, which is delivered when the software is purchased. Product activation is supported by QPR Customer Care (contact information 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.
44
5.1
Activating purchased QPR Products has been made as easy as possible with automatic activation via web. As a last step of QPR 8 installation, the QPR Product Activation Wizard is launched in the case you select so. The QPR Product Activation Wizard guides you through the process providing you with three different activation methods: Automatic Activation via Web Organization can activate the product automatically over the Internet and start using the software immediately. Manual Activation via Web - Organization can activate the product using their default 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 is connected to Internet Manual Activation via Phone/email Organization can activate the product by calling or emailing QPR Customer Care. During the activation, you'll also need to define the correct amounts of Portal Communicator and Portal Viewer user activations as well as the amount of QPR ProcessGuide and QPR ScoreCard Designer 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.
45
With the first two options it is no longer necessary to contact QPR Customer Care to activate the software. The QPR Product Activation Server works 24 hours a day 7 days a week listening for activation requests. The only thing needed is a valid Product Activation Code. Product Activation Codes are automatically created and sent to all QPR maintenance customers. The following process drawing describes the whole product activation process and the roles of QPR Partners and QPR:
46
47
5.1.1
Automatic Activation via Web is the easiest and quickest method of activating a QPR software product. Automatic Web Activation uses standard HTTP port 80 connections with encrypted messages to communicate directly with QPR Product Activation Server. The QPR Product Activation Wizard handles 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 encrypted information to server. Product Activation Server records user information and sends an Activation Key back to the Wizard. 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 using the product. Following process drawing illustrates the process of activating a QPR product automatically over the Internet:
48
5.1.2
Manual Activation via Web uses a Web Browser to communicate with the QPR Product Activation Server. The QPR Product Activation Wizard launches your default browser to send encrypted Activation Information automatically to the QPR Product Activation Server. These are the steps for manual 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 encrypted Activation Information automatically to the QPR Product Activation Server. Activation Server records user information and generates Activation Key(s) to Web page. You will 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 start using the product. 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 to Internet. All you need to have available is the Computer Code 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. Following process drawing illustrates the process of activating a QPR product manually over the Internet:
49
5.1.3
Manual Product Activation via Phone or email is convenient if there is no Internet connection available. To activate a product, you need to phone or e-mail QPR Customer Care. The QPR Product Activation Wizard gives detailed instructions on doing this. These are the steps for manual product activation 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 or save them to a file for printing. Contact QPR Customer Care by phone or e-mail. If e-mail is used, Product Activation Code and user information must be included in message. QPR Customer Care handles activation requests and provides you with an Activation Key. E-mail activation requests are handled within one business day. You will also get an Activation Status confirmation message by e-mail.
50
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 the product from any PC that is connected to Internet. All you need to have available is the Computer Code 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 other relevant activation related information, such as the number of licenses you have requested for each application.
Following process drawing illustrates the process of activating the software via email/phone:
51
52
5.1.4
QPR Product Activation can also be performed silently (i.e. so that no QPR Product Activation Wizard is displayed). The silent activation can be started in two ways: 1. 2. Launching QPR.WLT.exe with a /SILENTACTIVATION option 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 information exists in QPR.ini: Product Activation Code E-mail address First Name Last Name Country If all these are present, the silent activation is started. If some of the abovementioned information is missing, 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 file E-mail address is in the QPR.ini file Customer's name is in the QPR.ini file Activation status file is clean (i.e. right after the installation and the product has not been activated previously or the 14-day evaluation period used) If all the abovementioned requirements are met, the silent activation is started. Otherwise the QPR Product Activation Wizard is started in the normal mode. Note that the command line option overrides the QPR.ini setting, so even if the UseSilentForFirstActivation setting would be 0 (false), and the command line option is given, the activation is started in the silent mode providing that all the necessary information is included in the QPR.ini file.
5.1.5
QPR.ini is a configuration settings file that is used by all QPR software components. QPR Product Activation Wizard uses QPR.ini to store the activation server connection configurations and Customer Information. 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 to be used with installation program. Functionality has made so that if there is QPR.ini file located in same directory as QPR8Setup.exe (installation package) installation program will copy that file to the QPR 8 installation folder. This feature can be used to create 'Custom' installation packages with valid Product Activation Code included in QPR.ini.
53
5.2
The QPR Product Activation Wizard supports built-in 14-day evaluations that can be activated once per workstation. Extending the evaluation period is possible with a valid Evaluation Product Activation Code. All supported activation methods are available for extending evaluation.
5.3
Every organization must purchase a license that allows them to activate an adequate number of clients and users to cover the usage of QPR 8 software. QPR and QPR Resellers provide a unique Product Activation Code for each customer for installing the software. Customers are responsible for the use of their own Product Activation Code. Customer may change the Product Activation Code by sending a request to QPR Customer Care. Product Activation Code is the entry for QPR Product Activation Server's product activation account. All product activations applied with the Product Activation Code are recorded to the corresponding product activation account. Organizations may request activation status reports from QPR Customer Care. The Product Activation Code is also stored in the qpr.ini file in a plain text format for further
54
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 to start. In the case any number of users exceeds the number of activated users, the startup fails for QPR ScoreCard and QPR ProcessGuide servers. In addition, in the case there are more users than the activations allow, warning messages are displayed in the QPR User Management Server log file. Designers require a separate activation (by checking the corresponding checkboxes when activating 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 ProcessGuide Designer and ScoreCard Designer users must be defined when activating the QPR 8 installation. The Portal rights allow the use of all parts of Portal, i.e. Designer activations do not affect the use of QPR ScoreCard and QPR ProcessGuide Web Clients. In the case of QPR Portal, users with administrative or update rights are considered as full users and require a full user activation, while users in View rights to QPR Portal require Viewer activations.
5.3.1
Transient Licenses
QPR supports also a new Transient license type. Transient license agreement defines a fixed period of time for using the product. With QPR Product Activation Server Transient License Account there can be a fixed expiration date or a number of days the software can be used after activation. Definitions for transient license types: Transient License with fixed expiration date Hard Date Expiration. License Expiration Date is defined in QPR Product Activation Server's license account. Organizations can activate and use the product(s) with Transient Product Activation Code until the expiration date. After expiration date the Organization must renew the License Agreement. Transient License with fixed expiration time Soft Date Expiration. Number of License Expiration 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 a fixed number of days after activation. After expiration date the Organization must reactivate the product with Transient Product Activation Code. Transient license with 0 (zero) day soft expiration is a special case that can be used for example payper-use type of business models. Zero day soft expiration means in practice that the product must be reactivated every day it is used. QPR Activation Wizard supports this model by providing a possibility to reactivate a transient license silently. Silent reactivation for transient license can be set easily by changing 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 is created and the Organization gets a Product Activation Code for product activations. The Organization can activate the product freely with transient product activation code between June 1st 2003 and December 31st 2003. Product activation expires on December 31st 2003 and the software cannot be used on January 1st 2004. Example2: Organization makes a pay-per-use agreement with an ASP provider for using QPR Products. Transient License Account with 0 (zero) day soft expiration days is created and the Organization gets a Product Activation Code for product activations. Every time the product is started, silent reactivation is done to
55
QPR Product Activation Server. The ASP provider gets activation reports from QPR Software Plc. and charges the organization based on actual usage.
5.3.2
QPR ScoreCard Designer, QPR ProcessGuide Designer, and the QPR User Management Server now support transient product activations. There are two settings in QPR.ini file that affect the activation behavior: ShowTransientExpirationWarning is an integer value of 0 - n days that defines how many days before transient expiration date the warning messages are shown. If the value is 0 the warning messages are not shown. UseSilentForTransient is Boolean (values 0 / 1) flag that defines if silent reactivation is used when transient expiration has occurred. If the value is 1 (true), development client tries to start Product Activation Wizard in silent mode to reactivate the client. Wizard uses automatic product 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 About Box. 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 the software components correspond with the current pricelist: License in Pricelist Designer Communicator Viewer Server Software Component Development client Portal (with full rights) Portal (with view rights) Server
Designer licenses grant named individual users right to use either QPR ProcessGuide or QPR ScoreCard depending on the license. The amount of purchased developer licenses must correspond to the amount of users who have been granted access to QPR ProcessGuide or QPR ScoreCard Development Clients. Viewer licenses grant individual users rights to browse information in QPR Portal. However, users with viewer licenses cannot neither input data to QPR Portal nor create bookmarks or some other personalized information. The amount of purchased viewer licenses must correspond to the amount of users 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 by entering data into measures, creating actions, creating bookmarks as well as creating booklets. The amount of purchased full licenses must correspond to the amount of users who have been granted access to QPR Portal with Update rights or greater. Note that in the case the amount of users needing Portal viewer licenses exceeds the amount of purchased Portal viewer licenses, also Portal full licenses can be used for these users providing that there are spare Portal full licenses. However, the aforementioned substitution is not possible the other way around, i.e. spare Portal viewer licenses cannot cover missing Portal full licenses.
56
Each server license gives the right to install one copy of each included server component. The components may be located on different computers as well. See the tables below for information about how these licenses correspond with QPR User Management 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 are required to complement the Web Client rights UMS View = View rights for QPR User Management UMS Admin = Administrate rights for QPR User Management UMS Update = Update rights for QPR User Management PG Web Basic = Basic rights for QPR ProcessGuide Web Client PG Web Admin = Administrative rights for QPR ProcessGuide Web Client PG Dev Basic = Basic rights for QPR ProcessGuide Development Client PG Dev Admin = Administrative rights for QPR ProcessGuide Development Client SC Web Basic = Basic rights for QPR ScoreCard Web Client SC Web Admin = Administrative rights for QPR ScoreCard Web Client SC Dev Basic = Basic rights for QPR ScoreCard Development Client SC Dev Admin = Administrative rights for QPR ScoreCard Development Client Portal View = View rights for QPR Portal Portal Update = Update rights for QPR Portal Portal Admin = Administrative rights for QPR Portal Operations permitted with different license types: SC Designer PG Designer View ScoreCard models in QPR Portal View ProcessGuide models in QPR Portal Create Portal actions and enter data to QPR ScoreCard models via QPR Portal Create Portal actions and enter data to QPR ProcessGuide models via QPR Portal Viewer x x Communicator x x x Server
57
Develop and Administrate QPR ScoreCard models Develop and Administrate QPR ProcessGuide models Install QPR Server components
x x x
5.3.4
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 can optionally provide also /userid <your username> and /password <your password> switches. If you use the /userid and /password switches, the report is generated silently. Otherwise a login dialog for the 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 the report 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\QPR Software\QPR 8\8.1\Logs\ by default (C:\ProgramData\QPR Software\QPR 8\8.1\Logs\ on Windows Vista 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 in use. In addition, there are details available for users and groups. For different rights there's either a dash indicating that the right has not been granted or an abbreviation of the granted rights. The legend at the end of the report lists the abbreviations.
58
Activation Procedure
Activation Procedure
Activating QPR Products is a straightforward procedure. Follow the instructions below to activate your QPR product using the QPR Product Activation Wizard: 1. In the welcome page you can select the activation method and need to input your customer information. You can also view your current activation status by clicking the Activation Status button at the bottom left corner. If you don't have a product activation code yet, you can choose the 14-day evaluation activation provided that you haven't already used the evaluation period. In the case you select to activate using your product activation code, input the code into the corresponding field. If you have forgotten your product activation code or your 14-day evaluation period has expired, click the "Forgot your Product Activation Code? Evaluation period expired?" link. Fill in also your user information to the section reserved for it. Note that you need to fill in at least all the fields marked with an asterisk (*). In addition, use only Western characters in the form. After filling in the required information, click Next to continue. The information you provided is sent to QPR during the activation. 2. The License Agreement is displayed. After reading the license agreement, tick the "I accept the licensing terms" checkbox and click the Next button to continue. 3. The "Select Number of Licenses to be Activated" page is displayed at this moment. You can select to activate the QPR ProcessGuide and QPR ScoreCard Designers as well as the QPR Server by checking the corresponding checkboxes in the QPR Product Activation section. Input the amount of purchased QPR ProcessGuide Designer and QPR ScoreCard Designer licenses into the corresponding fields as well as the amount of QPR Portal Communicator and Viewer users into their respective fields. Viewer users are users with view-only rights to QPR Portal while Communicator users have update rights or greater. After verifying that the numbers correspond to the amount of licenses you have purchased, click Next to continue. 4. Define the activation method. You can choose to activate the software automatically or manually via Web or manually via phone or e-mail. After selecting the method, click Activate (or Next, if you selected manual activation via phone or mail). In the case you selected automatic activation via web, the product is now activated automatically. In the case you selected manually via web, the QPR Product Activation Wizard launches your default web browser and connects to QPR's licensing server. The web page that is displayed contains your Product Activation Keys. Input the keys into the corresponding fields in the QPR Product Activation Wizard and click Next to continue. In the case you chose to activate the software manually via phone or mail, follow the instructions given in the QPR Product Activation Wizard. After receiving the Activation Keys, go to the page following the instructions and input the key into the corresponding product fields in the Activation Keys section. Click Next to continue. 5. As the final stage, your new activation status is displayed. Please check that the information is correct and click Finish to close the QPR Product Activation Wizard.
59
The QPR ScoreCard system supports integration to external data through SQL import and OLAP import. 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.sql sql_QPR_ReportingViews.sql sql_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.
60
8
8.1
The QPR Configuration Manager is a tool that is used to configure all installed QPR products.
Configuration Files
The QPR Configuration Manager reads and writes changes to the qpr.ini-file located in the <path to All 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> in Windows Vista and later versions (not the QPR 8 installation folder, which is C:\Program Files\QPR 8 by default). There are also other qpr.ini-files, but those are not modified by the QPR Configuration Manager. 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 products such as the default language, E-mail settings, alert settings, and shared resources.
Language
In the Language section you can define the default language for QPR products from the drop-down menu. The default language setting affects the language that is used in login screens and is also the language that all the new users will be using when they log into the software for the first time. Users can override the default language by selecting another language for themselves. However, login screens will always use the default language.
E-mail Settings
61
In this section you can define settings for QPR Portal's and QPR ScoreCard's e-mail alerts and notifications. 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 the default 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 and provide the corresponding user name and password combination into the SMTP user name and SMTP password fields. Enter the e-mail address where the error messages will be sent to the Administrator e-mail address field. In the Reply address field enter the address that will appear as a sender's e-mail address and will also act as a reply address for users of the e-mail notification system.
Alert Settings
Check the Enable e-mail alerts checkbox to set the User Management System to send you messages 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 the System notifications option checked the administrator will receive notifications of basic system functions like starting or stopping the User Management System. With the Critical errors option checked the alarm message is sent in cases when the User Management Server is shut down due to a critical error.
Shared Resources
From the Shared Resources section you can enter the root folder for all the installed shared resources in 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\QPR Software\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 a folder 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 Settings
In 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 the use of scripts by selecting No scripts allowed to run, selecting the As previous, IWA allowed option will enable scripts in all development clients and Windows Explorer, and in addition Integrated Windows Authentication is allowed. To set a default script timeout for scripts that do not contain the setting themselves, enter a number in the Default script timeout field. The value is the interval (in seconds) for displaying a notification about a time-consuming script being executed. Setting this value to 0 disables the notification.
62
8.1.2
Database Operations
On the Database operations page you can define database settings and perform database operations.
Database
In this section you can define the database instance that is used by all QPR products. Select the desired ODBC data source from the Data source drop-down list and provide the required database login information to the User name and Password fields. The database operations you can perform include testing the database configuration, creating a new database, 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 been configured 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 a new database on the data source selected in the Data source field in the Database section, and all the previous contents of the database will be erased. Click Create to create a new database. A warning message will then be displayed stating that all the information on the selected database will be lost. Verify once more that the database does not contain any important information and then click 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 Import database section. You can either type in the path and the name of the file straight on the text field or alternatively you can use the Browse... button to locate the file. The import's target database is the data source that has been selected in the Data source field in the Database section. Click Import 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 Export database section. You can either type in the path and the name of the file straight to the text field or alternatively you can use the Browse... button to locate the file. The database that will be exported is the data source that has been selected in the Data source field in the Database section. Click Export 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.
63
User Management Server and the other QPR server components as well as between QPR User Management Server and Client. The Password field defines the server password for the QPR User Management System. This password can be used for logging into the QPR User Management Client even if there are no users that are allowed to access the QPR User Management Client. Note that you should change this password the first time you run the configuration utility to avoid security risks introduced by leaving the default password intact.
ProcessGuide Server
The 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 will use. If you do not want to use the default port, select the Custom port radio button and enter a desired socket port value into the Custom port number field. The Use encrypted communication checkbox enables or disables the encryption.
ScoreCard Server
The 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 Web clients. Default port for sending and receiving data is 20761. If you do not want to use the default port, select the Custom port radio button and enter a desired socket port value into the Custom port number field. Note: The Development and Web clients must be configured for the same port number you have entered here. The Use encrypted communication check box enables or disables the encryption.
Note
8.1.4
In the Server log settings section you can define the folder in which the log files are stored. By default this 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
64
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 is 25 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 Application Server plugins will use the normal logging mode. Force full trace mode for all products: All server components and Web Application Server plugins will use the full trace logging mode. Custom trace mode for each product: With this option you can select the logging mode individually 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 messages are 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 the appropriate Logging enabled radio button. When the audit log is enabled, all QPR ScoreCard Server measure changes are recorded into the SCSAudit.txt file and all QPR ProcessGuide Server operations to 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 Logging disabled, Basic logging enabled or Full logging enabled. For more details about the user audit log, see the User Audit Log chapter in QPR Administrator's Guide. For details about the Performance log settings, see the description for PerformanceLog key in Appendix 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. If the server components do not start within the given time, the NT service will be stopped. The maximum value for the Startup time is 99 minutes. You can change the value by either entering a new value manually to the field or by using the arrows on the right side of the field to scroll to the desired value. Check status every - NT Service will check the status of the QPR server components at the given intervals. If the QPR server components are not responding, then the NT Service is stopped. You can change the value by either entering a new value manually to the field or by using the arrows on the right side of the field to scroll to the desired value.
65
Response timeout - The time how long the service waits for status check response from QPR server components before giving an error message. You can change the value by either entering a new value manually to the field or by using the arrows on the right side of the field to scroll to the desired value. Force kill after timeout - If checked, then the NT service and the QPR server components controlled 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 of critical 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 manually to 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 QPR 8.1 or perform additional operations to the QPR 8.1 database. Some fields are pre-filled if this section is 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 default instance is used, so you need to change the value in the case you want to migrate a different instance. 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 file Actiontypes.ini: Action types available in QPR Portal Terms.ini: Terminology customization file The files are selectable in the case the corresponding files are found in the source folder and the target folder is defined. In the Source database section you can define the QPR 7.6/8.0 data source from which data is migrated to QPR 8.1. Define the data source and the user name and password (if any) required for the 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 imported from QPR 7.6/8.0 or to which additional operations are performed. Define the data source and the user name and password (if any) required for the database into the corresponding fields. When the migration is launched from the installation, the 8.1 demo database is suggested as the default.
66
Any possible QPR tables in the target database are overwritten, so make sure the database is either empty or you have up-toWarning date backup copies. In the Options for database migration section you can select additional operations to be performed 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 all element types that were using the previous duplicate versions. This setting is useful if you have duplicate custom attribute types originating from e.g. a database or file models created with QPR 7.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 publishing options into web styles, and overwrites any existing global web styles in the database. Make sure to have full backups of the QPR 8.1 database before using the migration options.
Warning
When the desired options are selected, click Run Migration to start the migration. After the migration 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 case some component is not installed, the Version field will have a "Not installed" text instead of the version number.
8.1.8
In this section you can define settings for the QPR User Management Server.
Authentication Method
Here you can select the method which is used for authenticating the users. For example, if Windows NT 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 On
Here you can select the components for which the Windows Integrated Authentication (IWA) is enabled. The options are: QPR Portal: Enables single sign-on for QPR Portal. When this option is enabled, you need to define the CGI binary IP setting.
67
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 generic single sign on authentication. Currently the only option is QPR Portal, and selecting it requires that the CGI binary IP setting is defined as well as qprsettings.dat modified accordingly. See "Using Single Sign-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.exe resides in. This is required for single sign on authentication to QPR Portal.
User Group
Here you can select the group management method. The Synchronized with NT/LDAP option makes the User Management System groups to be synchronized with NT/LDAP groups for authentication purposes. In the case you want some user group to act as a default group, select the Use default user group checkbox and insert the group's name into the Default user group field. The default user group is used when NT/LDAP users are imported, and a group with a name similar to their NT/LDAP group does not exist in UMS. For more information about the default user group, refer to the NT & LDAP Authentication section in QPR Administrator's Guide. The UMS only option means that the user groups are maintained only by QPR User Management System. With this option the groups are not synchronized with NT/LDAP groups for authentication purposes.
Autologin Settings
Here you can define options for cookie-based automatic login to QPR Portal. There are three options to choose from: Enable autologin with cookies as default option. With this option there is a "Login automatically next time" checkbox at Portal's login screen and it is checked by default. Users who leave the option on have their login information stored in a cookie and can login to Portal automatically after the first login unless they explicitly remove the cookie (either from the browser's settings or by clicking the "Clear automatic login information" button at Portal's logout screen. Enable autologin with cookies option. With this option there is a "Login automatically next time" checkbox at Portal's login screen. The checkbox is unchecked by default, but otherwise the functionality is similar to the previous option. Do not use cookies for autologin. The "Login automatically next time" option is not displayed
68
8.1.9
LDAP Settings
LDAP (Lightweight Directory Access Protocol) can be used to import users into the QPR UMS (User Management System). The LDAP Settings page requires some specific information and settings of your LDAP server. If you do not know the required information, you should contact your LDAP administrator.
LDAP Settings
Enter 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 "Active Directory". The selected Naming Convention defines what kind of naming conventions are used for LDAP connection parameters. The "Standard" setup is used to communicate with, for example, Lotus Notes. Whereas the "Active Directory" setup is used to communicate with Windows Active Directory LDAP. In Secure connection, select the "Always use secure connection" option to verify that only secure connections 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). In order for SSL connections to work correctly, the following 3 preconditions must be met: 1. 2. 3. The LDAP server must support and accept connections via SSL. 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. 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 the current page, "LDAP Settings", of this configuration utility).
Enabling trust for a certificate authority (i.e. fulfilling precondition 2) is done in Windows by adding the certificate authority's certificate to the list of "Trusted Root Certification Authorities". For further information about enabling trust for certificate authorities, consult your Windows support documentation. Note that currently a secure LDAP authentication requiring a client certificate is not supported.
69
Email attribute
Member attribute
Description attribute
Filter for searching groups Filter for searching persons Used id attribute name
Description Attribute name of an LDAP directory entry, which identifies the full name of the user. If the value is not defined explicitly, the default value is used, i.e. the value set to Common name attribute. If the value is defined, it overrides the default value. Attribute name of an LDAP directory entry, which identifies the email address of the entry. When importing users, this is mapped as the email address of the user. Attribute name of an LDAP directory entry. This attribute identifies one group member. An entry having this attribute represents some kind of group. The entry has one (Member attribute, DN of the member) pair for each of its members. Attribute name of an LDAP directory entry, which identifies the description of the entry. When importing users, this is mapped as the description of the user. Groups are retrieved from the LDAP directory using this search filter. Users are retrieved from the LDAP directory using this search filter. Attribute name of an LDAP directory entry, which identifies the user id (login name) of the entry. It is mapped as such when importing users. The distinguished name of the entry under which the search is performed on. Used when searching for groups in LDAP. If set to <Default>, the value of SearchBase in qpr.ini is used (see Appendix A in QPR - Administrator's Guide for description of the SearchBase key). Defines whether Global Catalog searching for Active Directory objects in any domain in the forest is enabled.
70
Setting
Description changing groups in LDAP may result in users and related data (actions, element owners) being removed from QPR UMS. Defines the initial start time of group synchronization. Format is datetime (yyyy-MM-dd hh:mm). Defines the interval between group synchronization operations starting from the time defined in Start date and time. The correct format for this setting is a colon-separated list of days, hours and minutes. For example, if Start date and time=2008-15-01 01:15 and Synchronization interval=01:00:00, the first synchronization takes place on 2008-15-01 01:15 and subsequent synchronizations are done every day at 01:15. A comma-separated list of groups which are excluded from synchronization. In the case a user belongs to any of the groups listed in this setting, the synchronization does not affect that user. Note that the group name must be contained in double quotes in the case the name contains spaces. Name of the group where users not found in LDAP are moved during synchronization if obsolete users are set to be deleted. If this is empty, the affected users are deleted from QPR UMS. By default this is "#Deleted users#".
71
Here you can define the settings for responding to model requests, which determines how to operate when 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 to export the model in the cases where the model is reserved, e.g. the user is editing the model at the same 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, either enter 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 after the export has been attempted long enough, the exporting of the element fails. To change the value, 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, the exporting is retrieved at 5 seconds intervals for three minutes or until the export succeeds.
Memory Usage
The Maximum memory usage setting defines the maximum amount of memory in megabytes that ScoreCard Server and Plugin are allowed to use before non-critical caches are cleared and all measure values in all models are written to QPR EMS (Extended Memory Storage). QPR EMS is used by QPR ScoreCard Server and QPR ScoreCard Plugin as an extension to the memory for storing information such as measure values and calculation rules. Setting this to 0 (default) disables the limit. Otherwise the minimum value is 128 and the maximum value is 3072. This setting should be used only if you are experiencing problems with memory consumption.
Cache Settings
Here you can define how long unused models will be cached, i.e. can be accessed faster. Especially in larger organizations with lots of models in the database it is a good practice to remove idle models soon. That way the server has more resources available for the active models. You can define the maximum amount of days the model can be unused before it is cleared from the cache memory. This can be done in two ways: Either type in a new value to the Remove models from memory if not accessed in _ days field or use 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 ProcessGuide Application Server. With this option you can reduce the memory usage in the case you have many large models stored in the server. Note that this limit can be exceeded temporarily, since the memory usage is checked every 10 minutes. You can define the maximum memory usage (128 minimum, 3072 maximum) in megabytes to the Maximum server memory consumption field either by entering a new value manually to the field or by using the arrows on the right side of the field to scroll to the desired value. The Cache embedded information items to section defines how embedded information items will be stored in the local computer. The options are:
72
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 in RAM and when the defined maximum size is exceeded, the information item 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 value manually to the field or by using the arrows on the right side of the field to scroll to the desired value. If you select the Clear disk cache at startup checkbox, the model cache will be cleared at server startup. In the case this option is not selected, old cached files are utilized if their contents are up to date, thus resulting in a faster startup. The selection in Model caching section defines how models are loaded into the QPR Web Application Server at startup: Option Base and published models, drop from memory Description Base models and published models that do not have an existing cache file are loaded from database and written to cache. After this models are dropped from the memory. Base models and published models that do not have an existing cache file are loaded from database and written to cache. Models are dropped from the memory in the case the memory limit is exceeded. Base models that do not have an existing cache file are loaded from database and written to cache. No models are loaded from the database.
Model Options
Selecting the Enable version management for new models makes all new models use version management by default.
Session Settings
Here you can define the Expiration timeout setting. The Expiration timeout setting defines the time how long a user can be idle before he or she has to log in again. You can change the value either by entering a new value manually to the field or by using the arrows on the right side of the field to scroll to the desired value. The Expiration timeout after logout is the time in seconds that a user's session remains active after logout. The setting is used in demo portals, where all users use the same User information. If some 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 Settings
Here you can define the maximum amount of server computer memory QPR Web Application Server is allowed to consume. Define the desired value in megabytes to the Maximum server memory consumption field. The value of this setting affects e.g. the amount of models cached in the memory
73
and therefore also for example searches. The % of maximum memory freed if limit exceeded setting defines the per cent value of the threshold for the Maximum server memory consumption when the memory limit has been exceeded, so that WAS will drop models from memory until memory usage is <value>% under the specified Maximum server memory consumption. The default value is 20. The Cache embedded attachments to section defines how embedded attachments will be stored in 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 RAM and 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 value manually to the field or by using the arrows on the right side of the field to scroll to the desired value.
Web Content
Here 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 often http://127.0.0.1/ (localhost) You cannot use http://127.0.0.1 if QPR Web Application Server is accessed from other computers or the web server is installed on Note some other computer. You have to set either the IP address or the web server's server name (for example "myserver.com") to this parameter instead. Users are not able to see any images if http://127.0.0.1 is used. The Web content URL field points to the location where the QPR Web Application Server's web content files are installed in your web server. QPR Web Application Server (WAS) uses this URL when it generates links to the HTML files, images and other web content files that WAS and other installed QPR 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 the QPR Web Application Server only on your own computer and the web server is installed on the same computer, then you can use the local host address 127.0.0.1. If QPR Web Application Server 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, which is 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, so this parameter is empty. Some examples of web content URL if installed to a web server which resides at the same computer as QPR Web Application Server, and is accessed only from the same computer:
74
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.exe for servers running the CGI binary on Windows platform, qpr.cgi on others, and qpr.dll in the case the ISAPI 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. The default login view can be either default (QPR Homepage) or a custom address, which can be typed into the Custom URL field.
75
General Settings
Read-only mode Select this check box to set QPR Portal available in read-only mode for all users. This is useful when you wish to use QPR Portal in demo mode so that users cannot make any modifications, such as changing 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 the Portal but the setting is only applied to the current session, i.e. it is not reused in the next session. Allow password changing Keep 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.
76
77
unchecked, the external model is opened in the current browser window. This setting can be overridden 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 used during 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 ProcessGuide Server.
Flow Charts
The Flow Charts section controls the settings for generating flowcharts. The Picture storage radio buttons allow you to select whether to save the images in your computer's memory or to its hard disk. The Image format drop-down menu lets you choose whether to save the images in PNG or JPEG format. JPEG-images are good for small and medium flowcharts whose colors are somewhat homogenous. PNG-images can be used for large files and/or files with a lot of details and different colors. You can define whether there will always be links to flowcharts in the Details view by selecting the Always provide a link to a flowchart checkbox.
General Settings
To enable caching in browsers, check Allow browser caching. With this option selected, browsers save and fetch pages from the local hard drive instead of downloading them from the QPR Web Application Server. However, if the model data is changed, users may not see the changes because they 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 is reserved e.g. for recalculation. In the case buffered input is allowed, values can be input when the model is reserved, but the new values are stored in a temporary buffer and applied to the model once the reservation is freed.
78
The Enable hyperlinks for text values check box defines whether hyperlinks are created automatically in QPR Portal from URLs entered as text type measure values.
Graphical Views
To 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 case this setting is incorrect, the floating toolbar in Scorecard View and Strategy Map view will not work correctly, so it is important that this setting matches the installed viewer version. The table below lists the known limitations with different options: Viewer Adobe SVG Viewer 3 or Later Limitations None with Internet Explorer. With other browsers extra popup 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 the SVG viewer's native strings are shown in the viewer's language, but strings specific to QPR Portal are shown in the currently active Portal language. The Use bitmap text in graphical views checkbox defines whether the SVG/Silverlight views display text as bitmap graphics instead of using text capabilities of SVG and Silverlight. This setting is useful e.g. in situations where some language-specific features such as joining characters based on their context don't work properly.
79
Report Options
In the Report file extension field, you can define the report file extension to be used.
Scorecard Visibility
From the Scorecard hierarchy section, select which scorecards are hidden in the scorecard hierarchy 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 form a hierarchy. Hide inaccessible leaves: If the user doesn't have rights for a scorecard that has no children or the user doesn't have rights for the children, that scorecard and its children are hidden from the hierarchy. All other scorecards are left visible, even if the user had no rights for them. Hide inaccessible branches: Scorecards for which the user has no rights and all its children are 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 the hierarchy and their children are attached under the deepest prevailing parent. If a user has no 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 has no 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 user has no rights are not shown. Instead, their names are displayed as "Access Denied".
8.2
8.2.1
The Web Client Scorecard View is made viewable through a browser SVG viewer plug-in. If the automatic Adobe SVG plug-in installation is enabled, then you will be prompted to download the Adobe SVG Viewer plug-in the first time you select to view the Scorecard View and no SVG viewer is already 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
80
Viewer for each user separately. If no other compatible SVG viewer is installed on the user's machine and an automatic installation of the 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
Each QPR Web Application Server installation must have its own folders for cgi-binaries and graphics files. This can usually be done either by mapping directories directly to installation directories (which can be located anywhere) or by installing the Web Application Server's cgi-binaries and graphics files into folders, which are under folders that is accessible in the web.
8.2.3
The error messages related to the use of QPR WAS can be customized to suit the user's or the organization's needs. To do this, edit the qprsettings.dat file, which is stored in the CGI-binary installation directory. See Appendix D for information about settings available in qprsettings.dat. Some error 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 not sufficient to get qprsettings.dat changes into use, but you also need to restart IIS e.g. by running iisreset.
81
This chapter provides information about configuring and using the QPR User Management Server and using the different user authentication methods supported by the QPR User Management System.
9.1
Normally a user logs into the User Management System by using his or her UMS username and password. 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, you have to enter only the User Management System server password into the password field. The username field can be left blank in this case.
9.2
You can define the users who have access to the User Management Client. This is done by modifying the users' properties in the User Management Client. To grant a user access to the User Management Client, enable the Development Client option for QPR User Management and set the correct access rights for that option. There are three alternatives: View, meaning that the user can only view (i.e. not modify) the information in the User Management 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 are granted administrator rights automatically.
9.3
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 allow you to easily set product rights for many users at once. Therefore you can grant product rights to one group that contains hundreds of users, rather than assigning the product rights to each of the users individually. See the QPR User Management System User's Guide for more information about adding, modifying, and deleting users and user groups.
82
9.4
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 they have 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 the imports.
9.5
Authentication Methods
The QPR User Management System can only be used for user authentication to QPR Products. Product specific 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 against the 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
Unless the User Management Server is installed as a service on a system account, one last step is required to configure the NT authentication method. The user account you are using to run QPR Service must have "Act as part of operating system" local security policy rights on the computer where the service is executed. Otherwise it is not possible to use NT authentication in the User Management System. 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
This chapter describes the steps required for using the synchronized NT/LDAP group management method. 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 QPR Configuration Manager. 2. Either: In the User Management Client, create a new group that has the same name as that in the 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 or the LDAP server. There is no need to have a similarly named group in the NT domain/LDAP
83
server. Open the QPR Configuration Manager utility Go to the QPR User Mgmt Server / General section Select "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 Group field. 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 group within the NT domain/LDAP server have access rights to those QPR products for which access was granted to in step 3. If there is no corresponding group and the Default User Group setting has been defined, 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 to that product). They do not belong to an NT/LDAP group that exists in the User Management System and has rights to QPR products. For users who belong to groups that have a similar name in both the NT domain/LDAP server and QPR UMS, the administrator can easily deny a user's access to the QPR product by simply removing the user from the group in NT domain/LDAP server. To do this, no modifications need to be made from within the QPR User Management System. Users' rights are defined by the rights of the group the user is part of in the QPR User Management System. However, users in the default user group are never 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 sync automatically. This means that whenever a user is added to LDAP to a group which exists also in QPR UMS, the user is added to QPR UMS during the next synchronization run without the user having to log into QPR products. In addition, updates to user details (full name, e-mail, telephone number, and description) done at LDAP are synchronized to QPR UMS during the next synchronization in the case the user exists in a similarly named group in both LDAP and QPR UMS. See the [UMS Settings] section in Appendix A for more details about the necessary configuration. NOTE If the Synchronized NT/LDAP Group Management is used, then the user is automatically either created or transferred to the UMS group under the same name as the user's NT/LDAP group or to the default user group when the user logs into some QPR product.
9.5.1.2
This chapter describes the steps required for setting the authentication method to either the NT or LDAP 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 in the "Authentication method" sub-section of the QPR User Mgmt Server / General section in the QPR Configuration 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's possible to authenticate users easily, using product permissions defined to the default user group in UMS. A group can be made the default group in the following way:
84
Open the QPR Configuration Manager utility Go to the QPR User Mgmt Server / General section. Select "UMS Only" in the "User Group" sub-section Insert 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 following preconditions 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 users User rights override group rights Stronger group rights override weaker group rights
9.5.2
It is possible to use single sign-on authentication with QPR products. QPR Portal, QPR Web Services Foundation, QPR ProcessGuide Designer, and QPR ScoreCard Designer support the use of Integrated Windows Authentication (IWA) for login. In addition, generic single sign on (SSO) is available for QPR Portal. With QPR Portal only Microsoft Internet Information Services (IIS) is supported as a web server. 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. For Single Sign-On to work, you need to have Windows NT and/or LDAP selected. In the case you are going to use Intergrated Windows Authentication with LDAP authentication, make sure Active Directory is set as the naming convention for LDAP (this can be done in the LDAP Settings subsection). 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 management method from the "User group" section. See the previous two chapters for more information about the user group management methods.
85
2. Change the following settings in the Single Sign On sub-section of the QPR User Mgmt Server section: Select the products for which you want to enable Integrated Windows Authentication (IWA) or generic Single Sign On (SSO) by checking the desired checkboxes. In the case you selected QPR Portal in either section, define also the IP address of the server computer containing QPR.exe/QPR.dll into the CGI binary IP field in the General Settings section.
86
The Single Sign On (SSO) option enables you to use single sign on in trusted environments where a web request's header variable carries the login name of the authenticated user. In the case your portal environment supports setting header variables for authenticated users, you can utilize the generic single sign on support for authenticating to QPR Portal. This functionality enables integration for 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 variable containing 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 QPR81 application / virtual directory and Portal virtual directory On IIS 7 and newer, also make sure that the Windows Authentication feature is installed on IIS.
87
9.6
In addition to the settings available in the QPR Configuration Manager utility, setup information can be modified in the "qpr.ini" file (in the common profile folder - see Appendix A for details). For general information about LDAP and LDAP settings in the QPR Configuration utility, see chapter LDAP Configuration 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 Protocol UID: The user ID attribute of Domino's LDAP person entries.
9.6.1
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 server with 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 to the LDAP server with a username/password combination. Leave this blank if an anonymous login
88
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 search starts 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 LDAP component and LDAP server for all other functions than Authenticate. AuthenticateViaSecureConnection: If both this and AlwaysUseSecureConnection are 0, then Authentication is done with insecure connection. If AlwaysUseSecureConnection is 1, then this setting has no effect (i.e. then it automatically defaults to 1). AllowConcurrentCalls: If this is 1, LDAP calls can be performed concurrently instead of being serialized. ActiveSettingGroup: Identification of the currently active setting group. Each setting group contains technical settings to be adjusted to the LDAP directory used. The setting group names are enumerated in an ini file section called LDAPSettingGroups. In that section, for each setting group identification there is the name of the section containing the settings for that setting group. See Example below. See Appendix A for more details about LDAP settings groups. An example LDAP configuration file:
[UMS LDAP] UIDAttrName=uid Username=CN=Testi Henkilo,OU=Oulu,O=QPR Password=qprqpr Searchbase= ServerAddress=10.0.12.10 AlwaysUseSecureConnection=0 AuthenticateViaSecureConnection=1 ActiveSettingGroup=1 AllowConcurrentCalls=0 [UMS LDAP Setting Groups] 1=Standard 2=Active Directory [UMS LDAP Standard] DistinguishedNameAttribute=dn CommonNameAttribute=cn EmailAttribute=mail MemberAttribute=member DescriptionAttribute=description PersonFullNameAttribute=<default> FilterForSearchingGroups=(|(objectclass=groupOfNames)(objectclass=group)) FilterForSearchingPersons=objectclass=person UIDAttributeName=uid UseADGlobalCatalog=0 [UMS LDAP Active Directory] DistinguishedNameAttribute=dn CommonNameAttribute=cn EmailAttribute=mail MemberAttribute=member DescriptionAttribute=description PersonFullNameAttribute=<default> FilterForSearchingGroups=objectclass=group FilterForSearchingPersons=objectclass=person UIDAttributeName=cn UseADGlobalCatalog=1
89
9.6.2
1. Open the configuration file "qpr.ini" for editing - see Appendix A for details about where the file is located. 2. Add a new section to the ini file. Give it a name which describes the new setup that you are creating. The format is [UMS LDAP <name of your settings>], for example "[UMS LDAP My Settings]". 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=dn CommonNameAttribute=<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, after the last item of the section:
[UMS LDAP Setting Groups] 1=Standard 2=Active Directory 3=My Settings
NOTE Add the name of your new setup under "UMS LDAP Setting Groups" section in ini-file. Add it as the last item of the section. Do not insert the name into some other location. The name of the new setup must be exactly the same as the name of the settings section. Use consecutive numbering, when entering the index for the new setup name. If the previous index was 2 (as in 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 settings group is now added and should be selectable in the configuration utility.
9.6.3
Before starting configuration, you should check that the Windows Active Directory LDAP in your server is activated. Verify also that the user name you are going to use to connect to LDAP server has been granted 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 = users User name = qpr Password = demo Domain name = testdomain Organization = qpr Location = fi LDAP Server IP Address = 127.0.0.1 No secure connection Login using predefined account The configuration information should appear in the QPR Configuration Manager utility as shown in the following picture:
90
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 the parameter 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 the parameter names may vary. This example describes the basic setup in Windows operating system using the English language.
9.6.4
Configuring the connection to Lotus Domino Directory is done in a similar manner as with a connection to the Windows Active Directory LDAP, which was illustrated in an example in the previous chapter. 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 be enabled, or there must be a person entry in the Domino directory, which has view rights to the users and groups that need to be accessed. In the latter case, the distinguished name (DN) and the password of that person entry must be written in the server configuration and the 'anonymous authentication' checkbox must be unchecked. Since the SSL Client authentication is not supported by UMS, this option should be switched off in the Domino if SSL is used. This example is going to use the following setup information:
91
User name = UserName Password = demo Organization = OrganizationName Location = fi LDAP Server IP Address = 127.0.0.1 No secure connection Login using predefined account The configuration information should appear in the QPR Configuration Manager utility as shown in the following 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 the parameter 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 the parameter names may vary. This example describes the basic setup in Windows operating system using the English language.
92
Web Publishing
10
Web Publishing
Information contained in QPR products can be easily communicated and utilized on the web. This chapter provides you with information about the different web publishing options available in the QPR 8 suite.
10.1
The most efficient and flexible way of publishing information from QPR products is to utilize QPR Portal, which runs on the QPR Web Application Server. QPR Portal combines information from QPR Software products (QPR ScoreCard and QPR ProcessGuide) into one portal view, which contains the relevant 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 preferences easily navigatable and searchable QPR Portal offers a generic tabbed web view, allowing a simple way to find and view the specific information that users need. It can be used to browse information published in both QPR ProcessGuide and QPR ScoreCard.
10.2
In addition to using dynamic web publishing with QPR Web Application Server, you can create static web pages of your QPR ProcessGuide and QPR ScoreCard models. See the subsections of this chapter for more information.
93
Maintenance
11
Maintenance
This chapter defines the different maintenance routines that need to be done by the QPR administrator. 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 the organization. This chapter assumes three different phases. Here are some characteristics of the different phases: Startup phase - The system is just taken into use. Mainly modelers are learning to use the system. 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 and reporting. 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 log folder. QPR applications can be configured not to restrict the growth of the log file, so taking backup copies 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 a corresponding log file. This information contain the internal state of the system at the time of the error helping QPR to pinpoint the problem. This information cannot be used by users to sort out the problem, but it should be communicated to QPR Customer Care instead. The debug information appears in the following format: <Time> <Date> <Product/Component> <Type (Information/Error/Notification)> <Thread id> <Message> where <time> has the format 'hh:nn:ss Below is a sample from a log file:
15:02:35 3504 02/07/08 started, version 8.0.9.116 UMS Information ID:3108 QPR User Management Server
zzz'
11.1
94
Maintenance
Check available table and transaction log space and increase if needed.
11.2
95
Maintenance
11.3
11.4
Archived Models Large models require a considerable amount of memory for QPR ScoreCard Application Server and QPR Web Application Server machines. To reduce memory consumption, large models can be archived 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 those models are not available on the QPR Portal. However, opening an archived model with QPR ScoreCard Development Client is possible. When the model is opened, QPR ScoreCard Application server will read it into the RAM and when it is closed, the allocated memory will be freed, which is not the case with regular models. Inter-model references to elements of an archived model cannot be created and any existing references cannot be refreshed until archiving is switched off. Furthermore, all scheduled tasks for an archived model are suspended. Configuration Utilities At the moment the QPR Configuration Manager cannot cope with the Far East double-byte characters as an input. Therefore it is important that only ISO 8859-1 (Latin-1) characters will be used with the input 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 not part of the localization. Therefore option strings are always in English regardless of the Portal's language setting. For information about customizing these options, see the Customizing Action Types
96
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. Remember to first check your log files when you encounter problems, because most errors are reported to the log files. 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 running The 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 QPR Customer 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 incorrect The 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 Server itself, 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 and QPR 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\QPR Software\QPR 8\8.1\Cache in Windows Vista and later versions). Before emptying the cache, make sure 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 Source Administration, which can be accessed from your Control Panel. If you are administrating QPR ScoreCard, you should define your DSN as a System DSN rather than a User DSN so that other users can access it as well. Open the SQL Import window and follow the same method of importing a SQL database. However, to import 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
97
Maintenance
import function interprets each sheet of an Excel workbook as one table. To import from the data source which uses text files, the SQL query is as follows: select * from textfile.txt (NOTE: In this case textfile.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 the SCS Scheduler section of the qpr.ini file. However, the value should always be several minutes to avoid errors (the values are in seconds, so 1200 means 20 minutes), but a too long time can increase the 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's size. In the case the threshold is exceeded, the information item is stored on disk instead of in memory. 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 server and a reply address in the QPR Configuration Manager's E-mail tab. Another reason could be that your SMTP-server is not functioning properly or that the users do not have valid e-mail addresses in the User 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 sufficient rights to the relevant Element (i.e. the one which contains the alerted value). Users must have at least "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's the problem here? A: Some buttons (e.g. Add to Basket and Actions) do not work properly if the Script location setting has not been configured properly in the QPR Configuration Manager utility. The setting is located in the Web Application Server -> Web Content section. The value should be a complete URL for the CGIbinary 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 are not 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) to a 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, it never 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 terminated before it has finished. To raise the times, launch the QPR Configuration Manager utility, open the
98
Maintenance
Common -> NT Service section, and try for example the following values: Startup time: 20 minutes Check status every X minutes: 20 minutes Response 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 to use ports 80 and 443 in the case the port specified during installation is reserved. This can be avoided by disabling the "Use port 80 and 443 as alternatives for incoming connections" option in Skype's configuration or changing your web server to use a different port (not recommended as all URLs would have to be updated as well). See http://support.microsoft.com/default.aspx?scid=kb;enus;816944 for more information. Q: I have a linked Information Item document residing on a network drive, and I can open it with Microsoft Internet Explorer but not with Mozilla Firefox. How could I get them both to work? A: Mozilla Firefox does not support all Windows path types and therefore linked files do not sometimes open correctly in Portal. It is advisable to put all shared documents into a folder on a web server and use regular hyperlinks (i.e. http://www.company.com/path/to/document.doc) instead of Windows paths. Q: I'm getting Response Processing Failed errors on QPR Portal even though the configuration appears to be valid. A: On some setups port numbers larger than 8191 are restricted, and as the QPR Web Application Server uses port 9000 as the default, the port number may need to be lowered. Please note that in addition to changing the QPR Web Application Server port using the QPR Configuration Manager, you will 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 create object: '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/or QPR ProcessGuide Designer. To fix the registration, do the following: 1. Launch command prompt with administrative privileges 2. 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.
99
Appendices
12
12.1
Appendices
Appendix A: Common QPR ini-file (qpr.ini)
This chapter describes the contents of the qpr.ini settings file. The sections are listed in alphabetical order. 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 only certain read-only settings. This is used only in the case the file in the All Users profile cannot be found. 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 systemwide configuration settings and for instance settings defined in QPR Configuration Manager are applied to this file. In the case this file is missing, the qpr.ini located in the QPR 8 installation folder is copied here. If the files are missing from both folders, an empty qpr.ini is created here and the default 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 System SCS = QPR ScoreCard Server SCC = QPR ScoreCard Client PGS = QPR ProcessGuide Server PGC = QPR ProcessGuide Client WAS = QPR Web Application Server WLT = QPR Product Activation Wizard SCP = QPR ScoreCard Plugin (i.e. the Web Client) PGP = QPR ProcessGuide Plugin (i.e. the Web Client) [PGC Activation] Section Field Field Type DefaultLicPath DefaultTSLicPath String String
Description Name and location (relative to the QPR root folder) of the file containing product activation information. Name and location (relative to the QPR root folder) of the file containing product activation information for Terminal Services. Defines whether a server or a client license is needed. 0 = server, 1 = client. 1 in this case.
DClientLicense
Integer
[PGC Flow Chart Print Settings] Section Field Field Type Description BlackAndWhite Integer Flag indicating whether the flowchart is printed in black and white. 0 = no, 1 = yes. Flag indicating whether organization item headers are reprinted on each page. 0= no, 1 = yes. Flag indicating whether checkpoint headers are reprinted on each page. 0= no, 1 = yes. Flag indicating whether the first page uses a separate settings. 0 = no, 1 = yes.
100
Appendices
Field FixedSize FitToOnePage FitToPages PrintSubprocesses LeftMarigin RightMarigin TopMarigin BottomMarigin ZoomTo PagesHigh PagesWide Orientation Page1HeaderItems Page1HeaderItem0..n
Field Type Integer Integer Integer Integer Decimal Decimal Decimal Decimal Integer Integer Integer Integer Integer Integer
Description Flag indicating whether the flow chart print is done in fixed size. 0 = no, 1 = yes. Flag indicating whether the flow chart print is fitted to one page. 0 = no, 1 = yes. Flag indicating whether the flow chart print is fitted to multiple pages. 0 = no, 1 = yes. Flag indicating whether all the subprocess levels are printed as well. 0 = no, 1 = yes. Left margin used in flow chart print. Right margin used in flow chart print. Top margin used in flow chart print. Bottom margin used in flow chart print. Value for fixed size used in flow chart print. Number of vertical pages used in flow chart print. Number of horizontal pages used in flow chart print. Flag indicating default printer orientation. 0 = Landscape, 1 = Portrait. Number of items in the header for first page. Index for item, 0 = name, 1 = version, 2 = printing time, 3 = creation time, 4 = last save time, 5 = page number, 9 = status Location of item, 0 = left, 1 = center, 2= right Font name. Font size. Flag indicating whether the item is bolded. 0 = no, 1 = yes. Flag indicating whether the item's is in italic. 0 = no, 1 = yes. Flag indicating whether the item is underlined. 0 = no, 1 = yes. Flag indicating whether the item is struck out. 0 = no, 1 = yes. Color number for the item Character set for the page header item font. Number of items in the header for other pages, integer. Contains the same values as the first page. Number of items in the footer for the first page, integer. Contains the same values as the header. Number of items in the footer for the other pages, integer. Contains the same values as the first page.
Page1HeaderItemLocation0 Integer ..n Page1HeaderItemFontName String 0..n Page1HeaderItemFontSize0 Integer ..n Page1HeaderItemFontBold0 Integer ..n Page1HeaderItemFontItalic Integer 0..n Page1HeaderItemFontUnde Integer rline0..n Page1HeaderItemFontStrike Integer out0..n Page1HeaderItemFontColor Integer 0..n Page1HeaderItemFontChar String Set0..n PageNHeaderItems Page1FooterItems PageNFooterItems Integer Integer Integer
101
Appendices
[PGC Flow Chart Settings] Section Field Field Type ShowHiearchy HierarchyWidth MinChartHeight Integer Integer Integer
Description Defines whether the process hierarchy and the Process Browser are shown. 0 = no, 1 = yes. Defines the Process Browser's width (in percents) in relation to the child window. Valid values are 1-50. Defines the Process Browser's height (in percents) in relation to the child window. Valid values are 150.
[PGC Intro Dialog, SCC Intro Dialog] Sections Field Field Type Description Version<version> Show Integer Integer Defines whether the introduction dialog is shown for this specific version. 0 = no, 1 = yes. Defines whether the introduction dialog is shown at startup. 0 = no, 1 = yes.
[PGC Log] Section See UMS Log [PGC Main Form] Section See SCS Main Form [PGC PG Publishing] Section Field Field Type TypePublishingData<1...N> Binary
Description Settings for the details view of an element type. Do not modify this value.
[PGC Recent Models] Section Field Field Type ModelName<0-3> ModelId<0-3> ForceExclusive<0-3> [PGC Settings] Section Field ForceAutomaticConnect String String Integer
Description Names of the most recently used models. IDs of the most recently used models. -1 with file models. Reserved for future use.
Description Defines whether the connection to ProcessGuide Server is forced, i.e. Development Client cannot be started if Server is not available. 0 = no, 1 = yes. Defines whether the Server connection is opened automatically when starting ProcessGuide. 0 = no, 1 = yes. Flag indicating whether a backup file is created when the model is saved. 0 = no, 1 = yes. Flag indicating whether the status bar is shown. 0 = no, 1 = yes. Defines whether a custom bitmap is used as main window background. 0 = no, 1 = yes.
AutomaticConnect
String
102
Appendices
Description The name of the custom background bitmap file. Flag used in model validation. 0 = no, 1 = yes. Flag indicating whether the "Do you want to close the model?" confirmation is asked. 0 = no, 1 = yes. Defines the delay time (in milliseconds) before opening the model. Flag indicating whether it is verified that the file actually exists before opening the file. 0 = no, 1 = yes. Flag indicating whether the working directory is changed to the directory where the file that is being opened is located. 0 = no, 1 = yes. Name and location of the default file model template, if used. Flag indicating whether the New Model dialog is shown when creating a file model. 0 = no, 1 = yes. The name of the directory where predefined integration settings files are stored (if this is missing, the application uses the default directory, which is <All Users profile>\Application Data\QPR Software\QPR 8\8.1\ PGIntegrationTasks, C: \ProgramData\QPR Software\QPR 8\8.1 \PGIntegrationTasks in Windows Vista and later versions). The font used in Analysis and Simulation graph views. If this setting is not defined, Arial is used by default. This setting can be used to correct font problems in some environments such as Thai, where for instance MS Sans Serif works fine. Size of the graph fonts. Size of the fonts used in graph titles. The font used in different sheet views (Analysis and Report views, Process Step, Flow, and Group dialogs). If this setting is not defined, Arial is used by default. This setting can be used to correct font problems in some environments such as Thai, where for instance MS Sans Serif works fine. Size of the sheet fonts. Defines whether a warning about the model having changed due to simultaneous editing is displayed. In the case the warning is not displayed, the changes are merged in the background and only possible conflict situations are shown, otherwise a message requesting the user to reopen the model from the server is displayed. 1 = show warning, 0 = don't show the warning. Defines whether custom attribute types are displayed in the flow chart as a horizontal attribute list. This setting is useful for flow charts created in
FileOpenChangeDir
Integer
GraphFont
String
SheetFontSize
Integer
ShowSimultaneousEditWarni Integer ng
HorizontalAttributeList
Integer
103
Appendices
Field
Field Type
Description QPR 7.5 since the visualization mode has changed to vertical after that. 1 = show horizontal attribute list, 0 = show vertical attribute list (default). Note that in contrast to the similarly named key in [PGP Settings] section, this is a user-specific key and therefore this should reside in qpr.ini located in the <path to user-specific profile>\Application Data\QPR Software\QPR 8\8.1\Settings\ folder.
CanEmptyChangeLog
Integer
Defines whether the user is allowed to empty or disable the change log in QPR ProcessGuide Development Client. 1 = the user can empty and disable the change log (default), 0 = the user cannot empty or disable the change log. Defines the folder that is opened by default with Open and Save As operations for models. This setting is used until the user uses some other directory for a successful model operation. The new folder will be the default folder for the rest of the Development Client session. In the case this setting is empty, the pgmodels folder under <All Users profile>\Application Data\QPR Software\QPR 8\8.1 (C:\ProgramData\QPR Software\QPR 8\8.1 folder in Windows Vista and later versions) is used by default. Defines the folder that is opened by default when the Run command for scripts is used and populates the Run Script menu by scripts in the folder. This setting is used until the user uses some other folder for opening a script successfully. The new folder will be the default folder for the rest of the Development Client session. In the case this setting is empty, the pgscripts folder under <All Users profile>\Application Data\QPR Software\QPR 8\8.1 (C:\ProgramData\QPR Software\QPR 8\8.1 folder in Windows Vista and later versions) is used by default. Defines whether flow end points are maintained or changed in relation to the element when the element is resized. 0 = relative end points (i.e. resizing the element moves also the flow end points) are used, 1 = fixed flow end points are used, i.e. the end points are not moved when the element is resized. In the case this key is missing, 0 is used by default. Defines the URL(s) of SharePoint site(s). If multiple sites are defined, the URLs need to be separated with semicolons. The default SharePoint site is the first one on the list. If this string is empty, SharePoint actions are disabled. Defines whether the information item icon is shown in the middle of an information flow, when only one information item is linked to the flow. 0 = icon is
DefaultWorkDirectory
String
DefaultScriptDirectory
String
FixedFlowEndPoints
Integer
SharePointSiteURLs
String
NoInfoIconForDefaultInfoIte Integer m
104
Appendices
Field
Field Type
[PGC Simulation] Section Field Field Type ActivationQueueSize StartDateTime SimulationLength SimulationSpeed SaveTimeInfo SaveCostInfo UseFlowIcons UpdateFrequency CreateFullReport FullReportFile CreateProcessStepReport ProcessStepReportFile CreateFlowReport FlowReportFile CreateResourceReport ResourceReportFile [PGC Web Link] Section Field LastReport Integer String Float Float Integer Integer Integer Integer Integer String Integer String Integer String Integer String
Description The size of the activation queue (maximum number of simultaneous activations). Date of starting the simulation. The length of the simulation. The simulation speed. Flag indicating whether the time information of the simulation is stored in the cases. 0 = no, 1 = yes. Flag indicating whether the cost information of the simulation is stored in the cases. 0 = no, 1 = yes. Flag indicating whether the flow transfer icons are used in animation. 0 = no, 1 = yes. Update frequency for flow chart animation. Valid values are 1-20. Flag indicating whether the full report is created. 0 = no, 1 = yes. The location for the full report file. Flag indicating whether the process step report is created. 0 = no, 1 = yes. The location for the process step report file. Flag indicating whether the flow report is created. 0 = no, 1 = yes. The location for the flow report file. Flag indicating whether the resource report is created. 0 = no, 1 = yes. The location for the resource report file.
Description The date and time of the last generation of the web pages.
[PGC XML Integration] Section Field Field Type SettingsFile ExportFile XSLTFile String String String
Description The full path and the file name of the last selected task file in XML integration. The full path and the file name of the last selected export file. The full path and the file name of the last selected XSLT file.
105
Appendices
Description A comma-separated list of model IDs of models that are loaded to memory when QPR Web Application Server is started. The list is maintained by QPR Web Application Server and contains the models that were in memory when QPR Web Application Server was last shut down. A comma-separated list of model IDs of models that are loaded to memory when QPR Web Application Server is started. This setting is maintained only manually, and if the value is empty or missing, the list is considered to be empty. Defines whether all models are loaded into memory when QPR Web Application Server is started as well as right after the model has changed. With different options this setting either overrides or utilizes the ModelsInMemory and LoadModelsToMemory keys. The options are as follows: 0 = No models are read into memory at startup. 1 = All models are read into memory at startup. 2 = Models listed in the ModelsInMemory key are read into memory at startup, 3= Models listed in the LoadModelsToMemory key are read into memory, 4 = Models listed in ModelsInMemory AND LoadModelsToMemory key are read into memory at startup. For standalone installation the default value is 1, but for other installations the default value is 4. Defines whether models in file cache are used during 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 ProcessGuide Server. 0 = no, 1 = yes. Defines whether custom attribute types are displayed in the flow chart as a horizontal attribute list. This setting is useful for flow charts created in QPR 7.5 since the visualization mode has changed to vertical after that. 1 = show horizontal attribute list, 0 = show vertical attribute list (default). Note that in contrast to the similarly named key in [PGC Settings] section, this is a global key affecting all users of the corresponding instance of QPR Web Application Server, and therefore this should reside in 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> folder in Windows Vista and later versions). Defines whether the information item icon is shown
LoadModelsToMemory
String
LoadAllModelsAtStartup
Integer
LoadModelsFromCacheFiles Integer
HorizontalAttributeList
Integer
NoInfoIconForDefaultInfoIte Integer
106
Appendices
Field m
Field Type
Description in the middle of an information flow, when only one information item is linked to the flow. 0 = icon is shown (default), 1 = icon is not shown.
[PGS Activation] Section Field Field Type DefaultLicPath DefaultTSLicPath String String
Description Name and location (relative to the QPR root folder) of the file containing product activation information. Name and location (relative to the QPR root folder) of the file containing product activation information for Terminal Services. Defines whether a server or a client license is needed. 0 = server, 1 = client. 0 in this case.
DClientLicense
Integer
[PGS Communication] Section Field Field Type ServerName ServerPort Connections String Integer String
Description Hostname or the IP address of the QPR ProcessGuide Server. Socket port of the QPR ProcessGuide Server. A semicolon-separated list of configured server connections. Each connection entry is a commaseparated list of the following values: Order number in the list, flag indicating whether the connection is the default connection (0/1), connection's name, server's host, and port. Defines whether encrypted communication is used. 1 = yes, 0 = no.
UseEncryption
Integer
[PGS Log] Section See UMS Log [PGS Main Form] Section See SCS Main Form [PGS Model] Section Field DaysInCache OnDisk
Description Defines the amount of days unused models are stored in cache memory before they are removed. Defines whether embedded information items exceeding the size defined in the Threshold setting are cached on disk (1, true) or on memory (0, false). 1 = true, 0 = false. The maximum size for embedded information items (in kilobytes) that are stored in the memory. If the size is exceeded, the attachments are stored in hard disk. Maximum memory usage in megabytes. Minimum value is 128, maximum is 3072. Note that this value can be exceeded temporarily.
Threshold
Integer
MaxMemoryUsage
Integer
107
Appendices
Field ClearDiskCacheAtStartup
Description Defines whether model cache on disk is cleared at startup. In the case this is 0 (false), old cached files are utilized in the case their contents are up to date, thus resulting in a faster startup. 0 = false (default), 1 = true. Defines how models are loaded into the QPR Web Application Server at startup. 0 = Base models and published models that do not have an existing cache file are loaded from database and written to cache. After this models are dropped from the memory. 1 = Base models and published models that do not have an existing cache file are loaded from database and written to cache. Models are dropped from the memory in the case the memory limit is exceeded. 2 = Base models that do not have an existing cache file are loaded from database and written to cache. 3 = No models are loaded from the database.
LoadModelsAtStartup
Integer
[PGS Service] Section See UMS Service [PGS Settings] Section Field LastFolder
Description ID of the last folder that was opened in the Application Server. Application Server uses this setting to open the same folder the next time the model selection dialog is opened. Defines whether audit logging is enabled. 0 = no, 1 = yes. Defines whether Integrated Windows Authentication (IWA) is enabled for QPR ProcessGuide Development Client. 0 = false, 1 = true. Defines the update method between QPR ProcessGuide Server and QPR Portal. 0 = Immediate, 1 = Scheduled. Default value is 0. If scheduling is used, PortalUpdateScheduleInterval must be defined. Scheduling applies to the following model operations: Save (not Save As), Replace, Rename, and Move (to another folder). However, in the case a new published model is created, models in Portal are updated at the moment the new model is saved. This setting can be used for example to schedule model update operations to occur outside the peak hours in environments with large models. Defines the initial start time of the updating between QPR ProcessGuide and QPR Portal if
AuditTrailTrace IWAEnable
Integer Integer
PortalUpdateMethod
Integer
108
Appendices
Field
Description PortalUpdateMethod = 1. If PortalUpdateScheduleStartDate is not defined, the server start date/time is used. Defines the interval between the updating of QPR ProcessGuide and QPR Portal starting from the time defined in PortalUpdateScheduleStartDate. Only one interval is supported. The correct format for this setting is a colon-separated list of days, hours and minutes. For example, if PortalUpdateScheduleStartDate = 12.12.2008 01:30:00 and PortalUpdateScheduleInterval = 01:00:00, the first update takes place on 12.12.2008 01:30 and subsequent updates are done every day at 01:30.
[Plugins Log] Section See UMS Log [Portal Default Views] Section Field Field Type scorecards actions processes mycontents [Portal Log] Section See UMS Log [Portal Settings] Section Field Field Type PwdChanging UseDefaultHomeView CustomHomeURL Integer Integer String String String String String
Description The default view for the Scorecards tab. The default view for the Actions tab. The default view for the Processes tab. The default view for the My Contents tab.
Description Allow password changing in Portal. 0 = no, 1 = yes. Defines whether the default home view is used. 0 = custom, 1 = default. Defines the URL of the custom home view if the default view is not used. Allow users to customize the view shown in my contents/home. 0 = no, 1 = yes. The tab that is selected by default when logging into the Portal. Allow users to customize the default tab selected when user logs into the QPR Portal. 0 = no, 1 = yes. Allow user to customize the default views opened when some tab has been selected. If not empty, determines the text used as label for category attributes in actions. Defines whether the Portal windows display the view titles (e.g. Add Action) in the browser window's title bar. 0 = no, 1 = yes.
AllowUsersToChangeDefault Integer Tab AllowUsersToChangeDefault Integer Pages CustomCategoryLabelText ShowViewTitles String Integer
109
Appendices
Field PublicBookmarkPositioning
Description Defines whether public bookmarks are shown after or before the user's own bookmarks. 0 = own public, 1 = public - own. Defines the default type of action. The default type is the type that is initially selected in the action editor when creating a new action. Defines the default option that is selected in the "Publish to" section when creating a new action. Possible values are: Users of linked elements, Me only, Everyone, and Selected users. Defines whether the "Notify via e-mail" option is checked by default in the action editor. 0 = no, 1 = yes. Defines the default type of attachments in the attachment editor. 0 = linked attachments, 1 = embedded attachments. Defines whether users with view rights only can create bookmarks in QPR Portal. 0 = disabled, 1 = enabled.
DefaultActionType
String
DefaultPublishTo
String
DefaultNotifyViaEmail
Integer
DefaultAttachmentType
Integer
[QPR Database] Section Field Field Type DBAlias DBLogin DBPassword ReconnectInterval ReconnectRetryTimes String String String Integer Integer
Description The database alias that is used by all QPR products. QPR database's login information. QPR database's password (encrypted). The amount of seconds to wait before trying to reestablish a broken database connection. The amount of times the database connection is tried to be restored. Defines the maximum amount of records that are stored with one SQL query. By default the value is 20. All positive integers from 0 upwards are valid values for this key. This setting can be used only with Microsoft SQL Server and Oracle databases. Defines the maximum size of blob fields that are stored with mass database operations. By default the value is 10000. All positive integers from 0 upwards are valid values for this key. This setting can be used only with Microsoft SQL Server and Oracle databases. Defines the time (in minutes) after which a warning message is inserted in the relevant log file(s). The warning is triggered in the case a transaction has been in a QPR server component's transaction queue longer than the value defined here. In the
MassOperationRecordCount Integer
MassOperationMaxBlobSize Integer
110
Appendices
Field
Field Type
Description case no value has been provided or the key is missing, 120 is used as the default value.
TransactionQueueMaxTime Integer
Defines the time (in minutes) after which an error message is inserted in the relevant log file(s). The error is triggered in the case a transaction has been in a QPR server component's transaction queue longer than the value defined here. Other database requests receive an error message telling that the database is overloaded until the transaction that triggered the warning is processed. In the case no value has been provided or the key is missing, 600 is used as the default value. Defines the maximum amount of transactions in the transaction queue. The default value is 100, but this can be increased to allow very large modeling operations to be done within a short time period with a slow database. The limit for the amount of transactions is meant to restrict loss of data in case the server is terminated before transactions have been committed to the database. This setting defines the interval (in minutes) between simple read operations that are performed to keep the database connection alive. This value is 0 by default (keepalive operations are not performed), but in the case you encounter problems with servers losing database connection after a certain amount of idle time, use this key with a value that's smaller than the idle time limit in your database.
DBConnectionKeepAlive
Integer
Description E-mail address that will be used as the reply address in e-mail notifications. Administrator's e-mail address. This address will receive alerts and notifications about server functionality. Name of the SMTP server used for sending the email notifications. The SMTP server port number used for sending the e-mail notifications. The default port number is 25. Login name for the SMTP server. Used in the case SMTPAuthentication is 1. Password for the SMTP server in an encrypted format. Used in the case SMTPAuthentication is 1. Defines whether SMTP server authentication is used. 0 = no, 1 = yes. Defines whether e-mail alerts are enabled. 0 = no, 1 = yes. Defines what kinds of events are alerted by e-mail.
111
Appendices
Field
Field Type
EnableBase64Encoding
Integer
Defines whether Action notification e-mails are sent as Base64 encoded UTF-8. 0 = disabled (default), 1 = enabled.
Description The font used in user interface controls of QPR ProcessGuide and QPR ScoreCard Development Clients. This setting is useful in the case the default font for example does not support all symbols in the language used in the model. Size of the UI font. Font used in all tree navigator controls in QPR ScoreCard and QPR ProcessGuide Development Clients. This setting is useful in the case the default font for example does not support all symbols in the language used in the model. Size of the navigator font Font used in the indicator view in QPR ScoreCard. This setting is useful in the case the default font for example does not support all symbols in the language used in the model. Size of the indicator font Font used in the history chart title in QPR ScoreCard. This setting is useful in the case the default font for example does not support all symbols in the language used in the model. Size of the chart title font. Font used in the legend of the history chart view in QPR ScoreCard. This setting is useful in the case the default font for example does not support all symbols in the language used in the model. Size of the legend font. The font used in Unicode user interface controls (currently only translation dialogs for multilingual modeling) of QPR ProcessGuide. Size of the Unicode font.
UIFontSize NavigatorFontName
Integer String
NavigatorFontSize IndicatorFontName
Integer String
IndicatorFontSize ChartTitleFontName
Integer String
ChartTitleFontSize LegendFontName
Integer String
LegendFontSize UnicodeFontName
Integer String
Integer
Description Defines the folder where all the logs are stored. If set, defines the logging mode for all products. 0 = force normal trace mode, 1 = force full trace mode, 2 = custom mode
112
Appendices
Field Location<0-9>
Description The location of an information item. The most recently typed location is the first and the others are sorted by time.
Description Defines whether service is installed. 1 = yes, 0 = no. The maximum number of seconds to wait for startup (control semaphore) before terminating the server process. Number of seconds to wait between successive server responsivity checks. Number of seconds to wait for server process to respond to the control message. Number of seconds to wait for the server process to shut down (when the service is being shut down) before terminating the process (if EnableForceKill=1). Determines whether the server process can be terminated by force if it does not shut down in ServerKillTimeout seconds after the shutdown message has been sent (0 = false, 1 = true). Defines the name that is displayed for the application in the service list. Defines how many times the service tries to start in case of critical error at startup. Name of the service used in dialogs and other user interface objects. Do not modify this value unless instructed to. Used for controlling the service. Do not modify this value unless instructed to. Used for controlling the service. Do not modify this value unless instructed to.
EnableForceKill
Integer
InternalName InternalBaseName
String String
Description Default language used by all QPR products. Default sublanguage used by all QPR products. Used for distinguishing between e.g. Chinese Traditional and Chinese Simplified, which both have the same DefaultLanguage entry. Defines whether a standalone version is installed. 1 = yes, 0 = no. This setting controls if the corresponding server components are launched when QPR ProcessGuide Designer or QPR ScoreCard Designer is launched. This option does not affect QPR Web Application Server or QPR Web Services Foundation.
Standalone
Integer
113
Appendices
Description The username of the last user who has logged into QPR products. The name of the last domain from which a user has logged into QPR products. Defines how QPR Scripts can be executed. 0 = scripts are not allowed to run, 1 = in Development Clients only, a confirmation is asked, 2 = in Development Clients only, no confirmation, 3 = running scripts is allowed both in Development Clients and in Windows Explorer, 4 = as with 3, in addition Integrated Windows Authentication is allowed. Defines the default timeout value for QPR scripts that do not contain the setting in the scripts themselves. The value is the interval (in seconds) for displaying a notification about a time-consuming script being executed. Setting this to 0 disables the notification. 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 512 bytes. 2 = compression is always used for all packets larger than 512 bytes. In the case this key is missing or the value has not been defined, 1 is used by default. This setting is a client-side setting, i.e. the client computer defines the use of compression. Defines the time (in minutes) for how long views with lots of list information (such as Analysis views and actions fields with lots of result rows) are cached. Updated information is guaranteed to appear in QPR Portal only after the time defined in this key has passed after the update. Note that lowering the caching time reduces performance. Setting this to 0 (default) disables the caching of query results. Defines the maximum interval (in minutes) between checking whether there are query results which have expired as a result of reaching the time defined in QueryResultExpirationTime. If such results are found, they are dropped from the memory. The default value is 5. Defines the folder in which cache files created by QPR server components are stored. Defines whether clear type font smoothing is used in QPR ProcessGuide flow charts even if clear type font smoothing has not been enabled in display settings, 0 = off (default), 1 = on.
ScriptTimeOut
Integer
ClientServerCompression
Integer
QueryResultExpirationTime
Integer
QueryExpirationCheckInterval Integer
CacheFolder
String
ForceClearTypeFontSmoothing Integer
114
Appendices
[SCC Activation] Section Field Field Type DefaultLicPath DefaultTSLicPath String String
Description Name and location (relative to the QPR root folder) of the file containing product activation information. Name and location (relative to the QPR root folder) of the file containing product activation information for Terminal Services. Defines whether a server or a client license is needed. 0 = server, 1 = client. 1 in this case.
DClientLicense
Integer
[SCC Intro Dialog] Section See PG Intro Dialog [SCC Log] Section See UMS Log [SCC Main Form] Section See SCS Main Form [SCC NavBar] Section Field ShowLeftNavBar ShowRightNavBar ShowLeftShapeGroup ShowRightShapeGroup
Description Defines whether the left navigation bar is shown in the Scorecard Explorer. 1 = yes, 0 = no. Defines whether the right navigation bar is shown in the Scorecard Explorer. 1 = yes, 0 = no. Defines whether the Shapes group is shown in the left navigation bar. 1 = yes, 0 = no. Defines whether the Shapes group is shown in the right navigation bar. 1 = yes, 0 = no. In the case this setting is 1 and the ShowLeftShapeGroup is 1 too, the Shapes group is shown in the left navigation bar. Defines whether the Elements group is shown in the left navigation bar. 1 = yes, 0 = no. Defines whether the Elements group is shown in the right navigation bar. 1 = yes, 0 = no. In the case this setting is 1 and the ShowLeftElementGroup is 1 too, the Elements group is shown in the left navigation bar. Defines whether the Scorecards group is shown in the left navigation bar. 1 = yes, 0 = no. Defines whether the Scorecards group is shown in the right navigation bar. 1 = yes, 0 = no. In the case this setting is 1 and the ShowLeftScorecardGroup is 1 too, the Scorecards group is shown in the left navigation bar.
ShowLeftElementGroup ShowRightElementGroup
Integer Integer
ShowLeftScorecardGroup
Integer
ShowRightsScorecardGroup Integer
Description Folder where reports are located. URL where published reports will appear.
115
Appendices
Field DefaultWorkDirectory
Description Defines the folder that is opened by default with Import and Export operations for models. This setting is used until the user uses some other directory for a successful import or export operation. The new folder will be the default folder for the rest of the Development Client session. Defines the folder that is opened by default when the Run command for scripts is used. This setting is used until the user uses some other folder for opening a script successfully. The new folder will be the default folder for the rest of the Development Client session. In the case this setting is empty, the scscripts folder under <All Users profile>\Application Data\QPR Software\QPR 8\8.1 (C:\ProgramData\QPR Software\QPR 8\8.1 folder in Windows Vista and later versions) is used by default . Defines whether Microsoft Windows GDI+ is used in drawing charts. 1 = yes (default) 0 = no. Disable this setting if you encounter troubles in drawing charts.
DefaultScriptDirectory
String
EnableGDIPlusGraphs
Integer
[SCP Log] Section See UMS Log [SCP Reports] Section Field WebReportPath WebReportURL ReportCommands ReportCommand<0...N>
Description Path where the published reports are stored. URL where the published reports are found. The amount of report commands Report command's name Report command's value. File extension for the report files. Path for an external report viewing application. Defines whether an external report application is used. 0 = no, 1 = yes. Defines whether extra files are removed from the web file publishing directory at startup. 0 = no, 1 = yes
ReportCommandValue<0... String N> FileExtension WebReportCGI UseCGI RemoveExtraFiles String String Integer Integer
Description Defines whether browser cache is in use. 0 = no, 1 = yes. Minimum amount of entries to show in the What's New page in Portal. Maximum amount of entries to show in the What's New page in Portal.
116
Appendices
Description The maximum amount of days included in the What's New page listing. Defines whether automatic SVG plugin installation is enabled. 0 = no, 1 = yes. Defines whether graphical Scorecard views are enabled. 0 = no, 1 = yes. The element graph layout of the element view is also hidden when this is set to 0. Defines whether old *.svg files are removed at startup. 0 = no, 1 = yes. Defines what SVG plugin is used. 0 = Adobe SVG Viewer 3, 3 = Microsoft Silverlight plugin (default). Defines whether value input is allowed when the model is reserved e.g. for recalculation. In the case buffered input is allowed, values can be input when the model is reserved, but the new values are stored in a temporary buffer and applied to the model once the reservation is freed. 0 = disabled (default), 1 = enabled. Defines the maximum amount of seconds to wait for a buffered value update to finish in QPR Portal. Default is 6 seconds. Defines whether SVG/Silverlight views display text as bitmap graphics instead of using text capabilities of SVG and Silverlight. This setting is useful e.g. in situations where some language-specific features such as joining characters based on their context doesn't work properly. 0 = disabled (default), 1 = enabled. Note that if this setting is enabled, charts in Element Views are always drawn as PNG images. Defines whether Microsoft Windows GDI+ is used in drawing charts if UseBitmapTextInGraphicalViews is 1 or the charts have background pictures. 1 = yes (default) 0 = no. Disable this setting if you encounter troubles in drawing charts. Defines which scorecards are hidden in the scorecard hierarchy view in QPR Portal when a user doesn't have enough rights. 0 = No scorecards are hidden (default), 1 = Scorecards for which the user has no rights are hidden from the hierarchy, after which the hierarchy is flattened, 2 = If a scorecard for which the user has no rights doesn't have any child scorecards or the user doesn't have rights for all of its children, that scorecard and its children are hidden from the hierarchy. All other scorecards are visible, even if the user had no rights for them, 3 = Scorecards for which the user has no rights and all its children are hidden from the hierarchy, no matter if the user had rights for some of the children, 4 = Scorecards for which the user has no rights are hidden from the hierarchy and their
WaitForValueUpdate
Integer
EnableGDIPlusBitmapGraph Integer s
ScorecardHierarchyMode
Integer
117
Appendices
Field
Field Type
Description children are attached under the deepest prevailing parent. If a user has no rights for the parents, the children are moved to the top level.
ScorecardNameMode
Integer
Defines how those scorecards for which the user has no rights but still remain visible in the scorecard hierarchy in QPR Portal after ScorecardHierarchyMode is applied are handled. 0 = The names of the scorecards for which the user has no rights are shown, but the links are not clickable (default), 1 = The names of the scorecards for which the user has no rights are not shown. Instead, their names are displayed as "Access Denied". Defines whether hyperlinks are created automatically in QPR Portal from URLs entered as text type measure values. 0 = Hyperlinks are not created automatically (default), 1 = Hyperlinks are created automatically.
[SCS Activation] Section Field Field Type DefaultLicPath DefaultTSLicPath String String
Description Name and location (relative to the QPR root folder) of the file containing product activation information. Name and location (relative to the QPR root folder) of the file containing product activation information for Terminal Services. Defines whether a server or a client license is needed. 0 = server, 1 = client. 0 in this case.
DClientLicense
Integer
Description Defines whether calculation is enabled for models by default. In the case calculation is disabled, values can still be input, but formulas are not calculated automatically. 0 = no, 1 = yes (default). A comma-separated list of names or IDs of models for which calculation should be enabled in the case calculation is disabled by default. Model names in the list must be in double quotes, and in the case any model name contains double quotes, the quotes inside the name must be preceded by another double quotes. It is also advisable to put the whole list inside double quotes to ensure that the quotes are parsed properly. A comma-separated list of names or IDs of models for which calculation should be disabled in the case calculation is enabled by default. Model names in the list must be in double quotes, and in the case any model name contains double quotes, the quotes inside the name must be preceded by another double quotes. It is also advisable to put
CalculationEnabledFor
String
CalculationDisabledFor
String
118
Appendices
Field
Field Type
Description the whole list inside double quotes to ensure that the quotes are parsed properly.
CalculatorThreads
Integer
Defines how many threads are used for QPR ScoreCard model calculation. If this value is changed, calculations which are not dependent on the results of other calculations are done in parallel in the defined amount of threads. The default value is 0, and in this case computers with a single processor use one thread for the calculation and computers with multiple processors use two threads. In the case there are less than 100 values to calculate, only one thread is used regardless of this setting. Defines how many values (every single value under every period and series in a measure counts as a separate value) are included in one calculation transaction during model recalculation. The default value is 1200000, and reducing this value consumes less memory during recalculation, but makes the calculation slower and vice versa. Note that modifying this value is usually unnecessary unless models are extensively large. Defines a threshold for triggering full model recalculation. The threshold is the amount of invalidated measure values after which instant invalidation of measure values is stopped and full model recalculation is automatically done after the operation which caused the measure value invalidation is completed. This option can be used to address situations where the amount of invalidated measure values causes memory consumption issues on the server. By default this is 0, which makes the option to use the value of the ModelRecalculationPeriodChunkSize key as the threshold.
[SCS Communication] Section Field Field Type ServerName ServerPort UseEncryption Connections String Integer Integer String
Description Hostname or the IP address of the QPR ScoreCard Server. Socket port of the QPR ScoreCard Server. Defines whether encrypted communication is used. 1 = yes, 0 = no. A semicolon-separated list of configured server connections. Each connection entry is a commaseparated list of the following values: Order number in the list, flag indicating whether the connection is the default connection (0/1), connection's name, server's host, and port.
119
Appendices
Description Defines whether automatic Development Client update is enabled. 0 = no, 1 = yes. Path where the installation package for the latest version is located.
Description Starting date for refreshing intermodel references. Accepted date format is "<d>.<m>.<yyyy>", where <d> is day, <m> month, and <yyyy> year with four digits. 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 two digits. Determines the refreshing interval in the precision of 5 minutes. The length (in minutes) of the actual interval can be calculated using the following formula: Refresh interval * 5. Defines whether unused replica model objects are scanned and removed regularly. Unused replica model objects are for instance replica element's value settings, which have been duplicated to the target model with earlier versions of QPR ScoreCard but which are unused now. 0 = disabled (default), 1 = enabled.
RefreshStartTime
String
RefreshInterval
Integer
[SCS Log] Section See UMS Log [SCS Main Form, SCC Main Form, PGC Main Form PGS Main Form, UMS Main Form, and WAS Main Form] Sections Field Field Type Description FormLeft Integer The main form's distance from the left side of the screen in pixels. If the value is -1, the default values are used. The main form's distance from the top of the screen in pixels. If the value is -1, the default values are used. Width of the ScoreCard / ProcessGuide Development Client main form in pixels. Height of the ScoreCard / ProcessGuide Development Client main form in pixels. Defines whether the ScoreCard / ProcessGuide Development Client is maximized at startup. 0 = no, 1 = yes.
FormTop
Integer
120
Appendices
[SCS Remote Model Export] Section Field Field Type RepeatAttempts Integer
Description Controls remote model updating. 0 = disable updating remote model. 1 = enable updating remote model. Determines how often model will be updated. The value is in seconds. Determines for how long the ScoreCard Application Server will try to update model. The value is in minutes.
RepeatInterval RepeatTime
Integer Integer
Description Enabling this property will accelerate report generating, but it will also slow ScoreCard Application Server down a little bit. 0 = no, 1 = yes. Enabling this property will accelerate report generating, but it will also slow ScoreCard Application Server down a little bit. 0 = no, 1 = yes.
MaintainHierarchiesRecent
Integer
Description The amount of seconds after which deleted objects are finally removed from the server. This should always be several minutes to avoid errors.
[SCS Service] Section See UMS Service [SCS Settings] Section Field IWAEnable
Description Defines whether Integrated Windows Authentication (IWA) is enabled for QPR ScoreCard Development Client. 0 = false, 1 = true. Defines the maximum amount of memory in megabytes that ScoreCard Server and Plugin are allowed to use before non-critical caches are cleared and all measure values in all models are written to QPR EMS (Extended Memory Storage). QPR EMS is used by QPR ScoreCard Server and QPR ScoreCard Plugin as an extension to the memory for storing information such as measure values and calculation rules. Setting this to 0 (default) disables the limit. Otherwise the minimum value is 128 and the maximum value is 3072. This setting should be used only if you are experiencing problems with memory consumption.
MaxMemoryUsage
Integer
121
Appendices
[SCS Thread Priorities] Section Field Field Type ClientManagerThreadPriorit Integer y DBManagerThreadPriority SchedulerThreadPriority Integer Integer
Description Thread priority of the Client Manager for Windows. Thread priority of the Database Manager for Windows. Thread priority of the Scheduler for Windows. Thread priority of the Socket Accept for Windows.
SocketAcceptThreadPriority Integer
[SCS Value Changed] Section Field Field Type Title Text String String
Description Title of the e-mail notification sent when a certain value is changed in ScoreCard. Notification text. In the case you need to add linefeeds, use the <NL> tag.
[SCS Value in Range] Section Field Field Type Title Text String String
Description Title of the e-mail notification sent when a value enters a certain range in ScoreCard. Notification text. In the case you need to add linefeeds, use the <NL> tag.
[SCS Value Missing] Section Field Field Type Title Text String String
Description Title of the e-mail notification about a value missing in ScoreCard. Notification text. In the case you need to add linefeeds, use the <NL> tag.
[UMS Action Plan Category Options] Section Field Field Type Description Option_<1...N> String Options in the Category drop-down box of an Action Plan action.
[UMS Activation] Section Field Field Type DefaultLicPath DefaultTSLicPath String String
Description Name and location (relative to the QPR root folder) of the file containing product activation information. Name and location (relative to the QPR root folder) of the file containing product activation information for Terminal Services. Defines whether a server or a client license is needed. 0 = server, 1 = client. 0 in this case.
DClientLicense
Integer
122
Appendices
Field Option_<1...N>
Description Options in the Category drop-down box of a Comment action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
[UMS Communication] Section Field Field Type ServerName ServerPort Password UseEncryption String Integer String Integer
Description Hostname or the IP address of the QPR UMS. Socket port of the QPR UMS. QPR User Management System's password (encrypted). Defines whether encryption is used in communication between the UMS server and client as well as between the UMS server and other QPR server components. 0 = no, 1 = yes. A semicolon-separated list of configured server connections. Each connection entry is a commaseparated list of the following values: Order number in the list, flag indicating whether the connection is the default connection (0/1), connection's name, server's host, and port.
Connections
String
[UMS Document Category Options] Section Field Field Type Description Option_<1...N> String Options in the Category drop-down box of a Document action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
[UMS Document Status Options] Section Field Field Type Description Option_<1...N> String Options in the Status drop-down box of a Document action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
[UMS Initiative Status Options] Section Field Field Type Description Option_<1...N> String Options in the Status drop-down box of an Action Plan action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
Description Address of the LDAP server. The distinguished name of the entry under which the search is performed on. If left blank, the search starts from the top entry. The distinguished name of the person entry used if the LDAP component logs in to the LDAP server with a username/password combination. If left blank, an anonymous login is used.
UserName
String
123
Appendices
Field Password
Description The userPassword attribute of the person entry used if the LDAP component logs in to the LDAP server with a username/password combination. Leave this blank if an anonymous login is used. The user password is stored encrypted. If this is 0, then an insecure connection is used between the LDAP component and LDAP server for all other functions than Authenticate. If both this and AlwaysUseSecureConnection are 0, then Authentication is done with insecure connection. If AlwaysUseSecureConnection is 1, then this setting has no effect (i.e. then it automatically defaults to 1). Identification of the currently active setting group. Each setting group contains technical settings to be adjusted to the LDAP directory used. This setting defines whether LDAP calls can be performed concurrently instead of being serialized. 0 = serialized calls, 1 = concurrent calls. In the case this key is missing, 0 is used as a default value.
ActiveSettingGroup
Integer
AllowConcurrentCalls
Integer
[UMS LDAP Setting Groups] Section Field Field Type <1...N> String
Description Name of the settings group, numbered in a consecutive order. The settings of the setting groups can be defined in [UMS LDAP <MyNewSetting>] sections similarly as in [UMS LDAP Standard] and [UMS LDAP Active Directory] sections.
[UMS LDAP Standard, UMS LDAP Active Directory] Sections Field Field Type Description DistinguishedNameAttribute String CommonNameAttribute String Attribute name of an LDAP directory entry, which identifies the DN of the entry. Attribute name of an LDAP directory entry, which identifies the full user name of the entry. When importing users, this is mapped as the user name of the user. Attribute name of an LDAP directory entry, which identifies the email address of the entry. When importing users, this is mapped as the email address of the user. Attribute name of an LDAP directory entry. This attribute identifies one group member. An entry having this attribute represents some kind of group. The entry has one (MemberAttribute, DN of the member) pair for each of its members. Attribute name of an LDAP directory entry, which identifies the description of the entry. When importing users, this is mapped as the description of
EmailAttribute
String
MemberAttribute
String
DescriptionAttribute
String
124
Appendices
Field PersonFullNameAttribute
Description the user. Attribute name of an LDAP directory entry, which identifies the full name of the user. If the value is not defined explicitly, the default value is used, i.e. the value set to CommonNameAttribute. If the value is defined, it overrides the default value. Attribute name of an LDAP directory entry, which identifies the user id (login name) of the entry. It is mapped as such when importing users. Defines whether Global Catalog searching for Active Directory objects in any domain in the forest is enabled. 1 = enabled, 0 = disabled (default). Groups are retrieved from the LDAP directory using this search filter. Users are retrieved from the LDAP directory using this search filter. The distinguished name of the entry under which the search is performed on. Used when searching for groups in LDAP. If set to <Default>, the value in SearchBase is used.
UIDAttributeName
String
UseADGlobalCatalog
Integer
[UMS Lesson Category Options] Section Field Field Type Description Option_<1...N> String Options in the Category drop-down box of a Lesson action. 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 Field Field Type Description Threshold MaxSize Integer Integer Defines the log trace mode. 255 = normal trace mode, 6577 = full trace mode. The maximum size of the log file in kilobytes. After the maximum size is searched, the old entries are overwritten starting from the oldest entry. Defines whether logging is on. 0 = no, 1 = yes. Defines the thread priority for the log writing process. If you wish to fine-tune your Web Application Server performance, you can modify this value. Valid values are 0-6, 0 being normal and 6 is the highest value. This option can be used only in the SCS Log section. Defines whether audit logging is enabled. 0 = no, 1 = yes. Defines whether a log file about the server's performance is maintained. This option can be used only in the UMS Log, the PGS Log, the SCS Log, and the WAS Log (even though the field is available in the other log sections too). The possible values are:
Enabled ThreadPriority
Integer Integer
AuditTrailTrace
Integer
PerformanceLog
Integer
125
Appendices
Field
Field Type
Description 0 = no performance logging, 1 = performance logging enabled, ending of client operations are logged, and 2 = performance logging enabled, starting and ending of client operations are logged. The performance logs are stored under the Logs folder with the following file names depending on for which servers the logging is enabled: WASPerfLog.txt, PGSPerfLog.txt, SCSPerfLog.txt, and UMSPerfLog.txt. The logs write also information about the duration of the operation. There are labels for different timeframes to make monitoring of log files easier. The labels are as follows: TIME_0T = the execution time was 0 ms TIME_1T = the execution time was 1-9 ms TIME_10T = the execution time was 10-99 ms TIME_100T = the execution time was 100-999 ms TIME_1000T = the execution time was 1.000-9.999 ms TIME_10000T = the execution time was 10.00099.999 ms TIME_100000T = the execution time was 100.000999.999 ms TIME_1000000T = the execution time was 1.000.000-9.999.999 ms (about 20 minutes - 3 hours) TIME_10000000T = the execution time was 10.000.000-99.999.999 ms (about 3 -30 hours) TIME_100000000T = the execution time was 100.000.000-999.999.999 ms (about more than 30 hours) TIME_NA= execution time could not be determined, error occurred or time was greater than 999.999.999 ms.
UserRightAuditTrailTrace
Integer
This option can be used in the SCS Log, WAS Log, PGS Log, and UMS Log sections (even though the field is available in the other log sections too). Defines whether server user audit logging is enabled for each server separately. 0 = logging is disabled, 1 = basic logging is enabled, 2 = full logging is enabled (the full logging option is available only for UMS Log section).
[UMS Main Form] Section See SCS Main Form [UMS Risk Category Options] Section Field Field Type Option_<1...N> String
Description Options in the Category drop-down box of a Risk action. This section is obsolete in QPR 7.6 and later.
126
Appendices
Field
Field Type
[UMS Risk Severity Options] Section Field Field Type Option_<1...N> String
Description Options in the Severity drop-down box of a Risk action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
[UMS Risk Status Options] Section Field Field Type Option_<1...N> String
Description Options in the Status drop-down box of a Risk action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
[UMS Service, PGS Service, SCS Service, and WAS Service] Sections Field Field Type Description Enabled ShutDownSemaphore ShutDownMessage ControlSemaphore ControlMessage CloseMessage Integer String String String String String Defines whether service is enabled. 1 = yes, 0 = no. Used for controlling the service. Do not modify this value. Used for controlling the service. Do not modify this value. Used for controlling the service. Do not modify this value. Used for controlling the service. Do not modify this value. Used for controlling the service. Do not modify this value.
Description Used internally by UMS. Do not modify. UMS Server's authentication method. 1 = QPR, 2 = NT, 4 = LDAP, or any combination of the values above. For example QPR + NT = 3 Defines whether Portal viewer users can change their profile information (e-mail, password, language) in QPR Portal. 0 = no (default), 1 = yes. Defines the user group management method. 1 = Synchronized with NT/LDAP, 0 = UMS only Name of a valid user group in UMS. This group is used as a default group in NT/LDAP syncronization. For more information, refer to the NT & LDAP Authentication chapter. Used internally by UMS. Do not modify. Used internally by UMS server. Do not modify. Defines how long user rights for PG and SC model
PreviousAlertMsg AlertCount
String Integer
ExternalObjectCacheExpirat Integer
127
Appendices
Field ionTime
Field Type
Description elements are cached for faster opening of action lists under the Actions tab in QPR Portal. Note that changes done to user rights within the expiration time are not applied to QPR Portal until the cache expiration time is reached. The default value is 900 (seconds, i.e. 15 minutes).
PortalAutoLogin
Integer
Defines whether login information is stored to cookies to enable automatic relogin to QPR Portal. 0 = autologin enabled and option at login view selected by default, 1 = autologin enabled, 2 = autologin disabled. This setting affects the users shown in the User Selection dialog in QPR Portal. In the case this is enabled, users without administrative rights to QPR User Management System see only those users who belong to at least one group the user him/herself also belongs to. 0 = disabled (default), 1 = enabled. Defines whether the change log is enabled for QPR Portal actions. 0 = disabled (default), 1 = enabled. Enabling or disabling the change log for specific action types is done in actiontypes.ini. Defines whether Single Sign On is enabled for QPR Portal. 0 = no, 1 = yes. Defines whether user information in QPR UMS is updated when a user logs in with an NT or LDAP account. When using LDAP and this setting is enabled, the information is updated also during the next synchronization if the user information has changed on LDAP. The following information is updated in the case this setting is enabled: Full name E-mail (LDAP only) Telephone number (LDAP only) Description 0 = disabled (default), 1 = enabled.
LimitedUserVisibilityInPortal Integer
EnableActionChangeLog
Integer
EnableSSOForPortal
Integer
SynchronizationMethod
Integer
Defines how UMS synchronizes users and groups with LDAP. 0 = no synchronization (default), 1 = users in groups found in both LDAP and UMS are synchronized with a schedule defined in SynchronizationScheduleStartDate and SyncronizationSchedulerInterval keys, 2 = users in groups found in both LDAP and UMS are synchronized similarly as with SyncronizationMethod=1, but obsolete users (i.e. users not found in LDAP anymore) are moved to a group defined by SynchronizationDeletedUsersGroup setting, and in the case the group is not defined, those users are deleted.
128
Appendices
Field
Field Type
Description WARNING: In the case synchronization is used, changing groups in LDAP may result in users and related data (actions, element owners) being removed from QPR UMS.
SynchronizationScheduleSta Datetime (yyyy- Defines the initial start time of group rtDate MM-dd hh:mm) synchronization which takes place if SynchronizationMethod=1 or SynchronizationMethod=2. SynchronizationScheduleInt String (dd:hh: erval mm) Defines the interval between group synchronization operations starting from the time defined in SynchronizationScheduleStartDate. The correct format for this setting is a colon-separated list of days, hours and minutes. For example, if SynchronizationScheduleStartDate=2008-15-01 01:15 and SynchronizationScheduleInterval=01:00:00, the first synchronization takes place on 2008-15-01 01:15 and subsequent synchronizations are done every day at 01:15. A comma-separated list of groups which are excluded from synchronization which takes place if SynchronizationMethod=1 or SynchronizationMethod=2. In the case a user belongs to any of the groups listed in this setting, the synchronization does not affect that user. Note that the group name must be contained in double quotes in the case the name contains spaces. Name of the group where users not found in LDAP are moved during synchronization (occurs if SynchronizationMethod=2). If this is empty, the affected users are deleted from QPR UMS. By default this is "#Deleted users#".
[UMS Strategy Item Category Options] Section Field Field Type Description Option_<1...N> String Options in the Category drop-down box of a Strategy Item action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
[UMS Strategy Item Status Options] Section Field Field Type Description Option_<1...N> String Options in the Status drop-down box of a Strategy Item action. This section is obsolete in QPR 7.6 and later. Use actiontypes.ini instead.
Description Defines whether embedded attachments exceeding the size defined in the Threshold setting are stored in disk instead of memory. 1 = yes, 0 = no.
129
Appendices
Field Threshold
Description The maximum size for embedded attachments (in kilobytes) that are stored in the memory. If the size is exceeded, the attachments are stored in hard disk.
[WAS Communication] Section Field Field Type ServerName ServerPort [WAS Log] Section See UMS Log [WAS Main Form] Section See SCS Main Form [WAS Messages] Section Field Field Type HTMLErrorTemplate HTMLCannotReadRequest String String String Integer
Description Hostname or the IP address of the QPR WAS. Socket port of the QPR WAS.
Description Template for a WAS error message. Template for WAS error message shown when a request cannot be read. Template for WAS error message shown when a request cannot be processed. Template for WAS error message shown if there are too many connections to WAS open at the moment. Template for WAS error message shown if the startup process has not been completed yet.
[WAS PG Publishing] Section Field Field Type DaysInRecentList DefaultZoomSize ElementTypes Integer String Binary
Description The maximum number of days for which an event is displayed in the "What's New" page in QPR Portal Default zoom size used for flowcharts. The value should be included also in the ZoomSizes entry. Binary entry that is used to save element type specific web publishing options. Tells when the flowchart images are generated (0 = on model load, 1 = when flowchart is needed for the first time). The storage place of flowchart images (0 = memory, 1 = hard disk) Number of footer items added into generated flowchart pictures. The location of the web contents when HTML export is used from ProcessGuide. Number of header items added into generated flowchart pictures. Defines the maximum size of flowcharts in pixels. If
FlowchartPictureGeneration Integer
130
Appendices
Field
Field Type
Description this setting has not been defined or the value is 0, the maximum size will not be used. If the maximum size is exceeded, the flowchart will be zoomed to the defined maximum size.
Minimum amount of entries to show at the "What's New" page in QPR Portal. Maximum amount of entries to show at the "What's New" page in QPR Portal. Show measure value hot spot (0 = no, 1 = yes) Binary entry that tells what model element information is shown in details window. See discussion below. Allow the usage of old model version when loading the new version. (0 = no, 1 = yes) The hierarchies shown in navigator. Bit 5: process hierarchy, bit 4: Organization hierarchy, bit 3: notes hierarchy, bit 2: resource groups hierarchy, bit 1: resource pools hierarchy, bit 0: information hierarchy Show link to flowchart after every flowchart object shown in any detail view (0 = no, 1 = yes). Show transfer type icons in the flowchart (0 = no, 1 = yes). Version of the PG whose initialization file specifications this file uses. The directory from which the layouts are fetched The name of the custom attribute that will be used as filename for generated HTML export pages and name of the view in dynamic web publishing. If WebPageNameAttribute=Name, then object's name will be used. List of comma separated zoom sizes shown in the published web pages (numbers should be between 10 and 200).
OldModelUsage ShowHierarchy
Integer Integer
ShowFlowchartLinkInDetails Integer Links ShowTransferTypeIcons Version ViewTemplateDirectory WebPageNameAttribute Integer String String String
ZoomSizes
String
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 flowchart header. Can be any of the following: 0 = Process level name 1 = Process level version 2 = Time of flowchart picture generation 3 = Model creation date 4 = Model last modified date
131
Appendices
Entry
HeaderLocation
0 = Left 1 = Center 2 = Right Name of the font. Size of the font. Use bold font (0 = no, 1 = yes). Use italic font Use underlined font Use strikeout font Font color as decimal number in 24bit RGB (16711680 equals to blue). Character set of the header font.
HeaderFontCharset
If FooterItemCount has been set to something else than 0, then every footer item has similar entries as 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 Field <Plugin name>
Description Defines whether a WAS plugin is installed and used. The numeric value after the name defines the log trace mode. 0 = normal trace, 1 = full trace.
Description The maximum number of requests that are handled simultaneously by QPR WAS. If the amount of requests exceeds the value defined here, new requests will not be processed until the old ones have been completed. If you are having problems with a multiprocessor machine, try lowering this value to 1.
The maximum number of requests that are handled simultaneously by QPR ProcessGuide Plugin (i.e. the Web Client). If the amount of requests exceeds the value defined here, new requests will not be processed until the old ones have been completed. The maximum number of requests that are handled simultaneously by QPR Portal. If the amount of requests exceeds the value defined here, new requests will not be processed until the old ones have been completed. The maximum number of requests that are handled simultaneously by QPR ScoreCard Plugin (i.e. the Web Client). If the amount of requests exceeds the
132
Appendices
Field
Field Type
Description value defined here, new requests will not be processed until the old ones have been completed.
The maximum number of internal (for example Login procedures and error messages) requests that are handled simultaneously by QPR WAS. If the amount of requests exceeds the value defined here, new requests will not be processed until the old ones have been completed. The URL for the Web Contents on the Web server. Note that http://127.0.0.1 cannot be used here if the QPR Web Application Server is accessed from other computers or the web server is installed on some other computer. This must be the IP address or the web server's server name (for example "myserver.com"). 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 Web Application Server is accessed from other computers or the web server is installed on some other computer. This must be the IP address or the web server's server name (for example "myserver.com"). The maximum idle time in seconds before the session expires and user is forced to log in again. The time in seconds that a user's session remains active after logout. Used in demo portals, where all users use the same User information. If some 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. Show the default or customized view in the login view. 1 = default, 0 = custom. URL of the view shown in the login view if the default login view is not used. Root folder for all the template folders. If this setting has not been defined, the <All Users profile>\Application Data\QPR Software\QPR 8\8.1 \Templates\WAS folder (C:\ProgramData\QPR Software\QPR 8\8.1\Templates\WAS folder in Windows Vista and later versions) is used by default. Defines whether Portal is in read-only mode. 0 = no, 1 = yes. Defines the maximum amount of memory in megabytes QPR Web Application Server is allowed to consume. This setting affects e.g. the amount of models cached in the memory and therefore also for instance searches. Defines the per cent value of the threshold for the
WebContentRoot
String
HostScriptLocation
String
SessionExpirationTimeout
Integer
ReadOnlyMode MaxMemoryUsage
Integer Integer
MemoryUsageLimit
Integer
133
Appendices
Field
Field Type
Description MaxMemoryUsage when the memory limit has been exceeded, so that WAS will drop models from memory until memory usage is <value>% under the specified MaxMemoryUsage. The default value is 20.
IWAEnable IWACGIBinaryIP
Integer String
Defines whether Integrated Windows Authentication (IWA) is enabled for QPR Portal. 0 = false, 1 = true. Deprecated. CGIBinaryIP is now used, but in the case this key has a value and CGIBinaryIP is undefined, the value of this key is read into the CGIBinaryIP key. Defines the IP of the computer where QPR.exe or QPR.dll is located. This option needs to be set only when IWAEnable or EnableSSOForPortal (in UMS Settings section) is set to 1. Defines whether HTML pages generated by QPR Portal are cached in the browser cache. The following values can be used: 0 = never cache pages, 1 = disabled by default, i.e. pages are not cached unless explicitly requested to do so. 2 = enabled by default, i.e. pages are cached unless explicitly requested not to do so. By default the value is 1. Defines whether QPR Portal URLs are encrypted (user account data is always encrypted regardless of this setting). 1 = plain text URLs are used, 0 = URLs are encrypted. By default the value is 1. Defines whether Portal templates are cached in QPR Web Application Server. Disabling this is helpful when customizing templates, as the templates are refreshed without restarting QPR Web Application Server. 1 = yes, 0 = no. By default the value is 1. Defines whether the link to QPR WorkFlow is enabled in QPR Portal. 1 = enabled, 0 = disabled. By default the value is 0. Defines whether the link to QPR FactView (a tab called Analytics) is enabled in QPR Portal. 1 = enabled, 0 = disabled. By default the value is 0. With this key you can define an offset (positive or negative) to be applied to the year values displayed in QPR Portal to accommodate for different calendars. Note that this setting affects only how the values are displayed, so calculations are not affected and two QPR Web Application Servers can utilize the same database with different offsets. However, negative offsets large enough to cause negative year values to be displayed in QPR Portal should not be used. Note that this setting affects also situations where action attribute values of the type date are
CGIBinaryIP
String
CachePages
Integer
ForcePlainTextURLs
Integer
EnableTemplateCaching
Integer
EnableWorkFlow
Integer
EnableFactView
Integer
UIYearOffset
Integer
134
Appendices
Field
Field Type
Description inputted. In those cases a reverse offset is applied to the values before inputting them to the database in order to maintain database consistency.
WebContentPath DefaultPortalMode
String Integer
Path where the QPR web contents are installed. Defines the QPR Portal mode that is used for a user that hasn't previously logged into QPR Portal. 0 (default) = Standard Portal, 1 = Mini Portal. Defines whether a button is shown in QPR Portal for changing the Portal mode between Mini Portal and Standard Portal. 0 (default) = button is shown, 1 = button is hidden. Defines the default mode of the Details Pane in QPR Portal. 0 = disabled, 1 (default) = minimized, 2 = open. Note that this setting is overridden if userspecific Details Pane mode is set in QPR Portal Settings page. Defines whether it is possible to change the Details Pane mode in QPR Portal or not. 0 (default) = Details Pane mode change is allowed, 1 = Details Pane mode change is not allowed. Defines the user groups of QPR User Management System whose members have the QPR FactView link (Analytics tab) visible in QPR Portal. To add multiple group names, separate the names with a comma (e.g. "FactViewUserGroup=Group1,Group2, Group3").
HidePortalModeChange
Integer
DefaultDetailsPaneMode
Integer
HideDetailsPaneModeChang Integer e
FactViewUserGroup
String
[WAS Service] Section See UMS Service [WLT Customer Info] Section Field Field Type CustomerCode FirstName LastName Email PhoneNumber Address PostalCode City Country Organization JobTitle UserComments PortalFullUsers String String String String String String String String String String String String Integer
Description Customer's Product Activation Code Customer's first name Customer's last name Customer's e-mail address Customer's phone number Customer's address Customer's zip/postal code Name of the city the customer lives in Name of the country the customer lives in Customer's organization Customer's job title Customer's comments Amount of activated Portal Communicator Users. This key is used during upgrade in the case license
135
Appendices
Field PortalViewUsers
Description file does not exist. Amount of activated Portal Viewer Users. This key is used during upgrade in the case license file does not exist. Amount of activated ScoreCard Designer users. The ScoreCard Server checks this value at startup, and if the amount of Designer users in UMS exceeds this value, the ScoreCard Server does not start. Amount of activated ProcessGuide Designer users. The ProcessGuide Server checks this value at startup, and if the amount of Designer users in UMS exceeds this value, the ProcessGuide Server does not start.
SCDclientUsers
Integer
PGDclientUsers
Integer
Description Defines whether transient product activation is done in a silent mode. Defines how many days before expiration the warning is shown. Default value is 0 meaning no warnings. Defines what licensing modes are available. Valid options are evaluation, internet, web, manual Defines whether the QPR Product Activation Wizard is started in the silent mode when the product is installed (requires certain prerequisites to be met, see the QPR Product Activation chapter for more details). 0 = no, 1 = yes.
[WLT Settings] Section Field LicensingServers LicensingPage LicenseFormPage ManualActivationURL SSLPort SSLProxyServer SSLProxyPort Timeout Email Helpdesk
Field Type String String String String Integer String Integer Integer String String
Description Domain name of QPR Product Activation Server. There can be domain names separated by ';' Rest of URL for automatic product activation via Web URL for manual product activation via Web URL for manual product activation via phone/e-mail. Socket port of the SSL server IP address of the SSL proxy server Socket port of the SSL proxy Timeout in milliseconds for socket connections QPR's Customer Care e-mail address for manual product activation instructions QPR's Support site's contact information for manual product activation instructions.
136
Appendices
12.2
The QPR 8 installation writes some entries to the Windows Registry under the HKEY_LOCAL_MACHINE\Software\QPR Software Plc. folder. The registry keys are as follows: Entry CGIPath Value Indicates where the CGI binary and script files as well as ISAPI DLL are installed. Note that if several CGI installations exist in the same computer, the location is the location of the latest installation. Example C:\inetpub\scripts
InstallPath
Indicates where the QPR suite is installed. C:\Program Note that if several installations exist in the Files\QPR 8 same computer, the location is the location of the latest installation.
Indicates where the QPR Web Application C:\inetpub\wwwroot Server's web contents (HTML and related files) are installed. Note that if several installations exist in the same computer, the location is the location of the latest installation. Registry entries under \HKEY_LOCAL_MACHINE\Software\QPR Software Plc\QPR Home 8.0 Entry Office2007Addin PGApplicationServer PGDevelopmentClient QPRWebServices SCApplicationServer SCDevelopmentClient UserManagementClient UserManagementServer WASAndPlugins Value Indicates whether QPR Add-In for Microsoft Office 2007 is installed. Indicates whether QPR ProcessGuide Application Server is installed. Indicates whether QPR ProcessGuide Development Client is installed. Indicates whether QPR Web Services Foundation is installed. Indicates whether QPR ScoreCard Application Server is installed. Indicates whether QPR ScoreCard Development Client is installed. Indicates whether QPR User Management Client is installed. Indicates whether QPR User Management Server is installed. Indicates whether QPR Web Application Server and plugins running on it are installed. Indicates whether a QPR Web Application Server's scripts (CGI binary & ISAPI DLL) are installed. Example 1 1 1 1 1 1 1 1 1
WebContentsPath
WASScripts
Indicates whether QPR Web Application 1 Server's Web Contents are installed. Registry entries under \HKEY_LOCAL_MACHINE\Software\QPR Software Plc\QPR Home 8.0 \InstalledFeatures
WASWebContents
137
Appendices
In the case QPR Add-In for Microsoft Office 2007 is installed, a QPR Software Plc.QPR Add-in for Microsoft 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 is copied 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 uninstallation and upgrades.
12.3
While QPR 8.1 can be installed side-to-side with earlier QPR versions rather easily (all the default folders are different), there are still a few issues you need to take into account if you are running both QPR 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 an older version simultaneously, port numbers for either version need to be changed. See the instructions 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 doubleclicked in Windows Explorer is the latest version that is installed. If you need to change this, do the following: 1. Open the command prompt 2. 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 the initial release of QPR 8.0. 4. Go to the corresponding folder for the version with which you want to open the scripts and run Proguide.exe /regserver or SCClient.exe /regserver. Parallel (side-by-side) installations of QPR 8.1 1. 2. 3. 4. Copy the QPR 8 installation folder under a new name, for example QPR 81_Instance2. Launch some executable from the new folder so that the settings are instantiated. Make a copy of your existing database and create a new, version-specific ODBC data source for it, for example QPR_81_2. 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. Note that it is essential that the name of the qprsoftware folder is not changed. Similarly create a new folder for the CGI binary and ISAPI DLL and copy QPR.exe, QPR.dll and
5.
138
Appendices
6.
qprsettings.dat into that folder. 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 avoid overlaps with the new version. Also change the webcontent folder entries. Consult the table below for information about the required changes: Group Database operations Server locations Change Change the data source to instance-specific one. Change the port numbers for all servers Change the web content URL to point at where the new instance files are installed. You may need to add a new virtual directory to Microsoft IIS at this point and update the value correspondingly. Change the script location to point at where the new instance files are installed. You may need to add a new virtual directory to Microsoft IIS at this point and update the value correspondingly. If this value hasn't changed automatically, change the Web file publishing directory and the Web file publishing URL to point to the new folders.
7.
Locate the qpr.ini file that corresponds to the installation. You can determine its location by going 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 the contents of the instances.ini file located there. Check the instance under which the installation folder is the one you created in step 1. The correct qpr.ini file will be located in Settings\<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 the name, 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 the template folders used by the instance. The template folder will be Templates\<Instance>\WAS relative to the folder containing the instances.ini file, i.e. in the case of the example the setting should be TemplateRoot=C:\Documents and Settings\All Users\Application Data\QPR Software\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 of HOST_PORT to be the same you defined for QPR Web Application Server in the Server locations 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 in the folder created in step 2 and update the values of InternalName and InternalBaseName keys in the [QPR Service] section to something else than the default ones (for instance QPR_81_2), but use the same value for both keys. After the qpr.ini modifications, you can start the service installation by opening the command prompt and running 'qprinit -i' in the Utilities folder. 11. Change the Development Clients of the parallel installation to use the new port numbers defined in step 6. 12. If you want to activate the parallel installation separately, open the instance-specific qpr.ini and modify the DefaultLicPath keys under the [<product> Activation] sections to contain the name
139
Appendices
of the instance folder (for example DefaultLicPath=umsauth.bin becomes DefaultLicPath=Instance 2\umsauth.bin). After that you need to create an instance folder under the License folder. For example, if the instance-specific qpr.ini is in the Settings\Instance 2 folder, the new folder under the License folder should also be called Instance 2. Finally you need 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 the new instance separately. Both installations can now be used simultaneously. Note that you need to modify the links pointing to the old Portal to point at the new folder. Also note that the parallel version can be removed or upgraded only manually.
12.4
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 not sufficient to get qprsettings.dat changes into use, but you also need to restart IIS e.g. by running iisreset. The following settings can be defined in the qprsettings.dat file: Key Type Description HOST_ADDR HOST_PORT MAX_UPLOADED_FILE_LENGTH MSG_PAGE_HEADER String TCP/IP address of the QPR Web Application Server computer.
Integer Socket port number of the QPR Web Application Server. Integer The maximum allowed size of uploaded files in bytes. String This is the text that is shown in the error message window title. Note also that this parameter has the start tags for the created error page. This is the message that is shown to the user if CGI binary cannot open connection to QPR Web Application Server. This is the message that is shown if the user request could not be processed (invalid format, connection to QPR WAS lost in the middle of processing, etc) This is the message that is shown if the response to user's request could not be processed (invalid format, illegal data, or some other error) This is the message that is shown if the file that is being uploaded into QPR Portal exceeds the limit set for the size of the uploaded files. This shows the possible footer text for the error message. Note that it also has the end tags for the created error message page.
MSG_CONNECTION_FAILED
String
MSG_REQUEST_FAILED
String
MSG_RESPONSE_FAILED
String
LOG_ENABLE
Boolean Defines whether logging is enabled for qpr.exe. See below for other requirements concerning logging. 1 = yes, 0 = no.
140
Appendices
Key LOG_THRESHOLD
Type
Description
Integer Defines what entries are written into the log file. If threshold is 255 or below, only errors are logged. With threshold of 511 or below both errors and warnings are logged, and with threshold of 65535 or below, notifications, warnings and errors are logged. Integer Maximum size of the log file in kilobytes. String Name of the log file. Integer Defines whether HTTP headers qpr.exe sends to web server are written to the log. 0 = no headers are written, 1 = headers are written into the cgibinresponse.txt file, 2 = headers and full content are written into the cgibinresponse.txt file. String Overrides the host set into HTTP headers of the request received by web server and CGI binary (qpr.exe). This is useful e.g. in situations where an authentication system modifies the headers and causes unnecessary redirects to QPR Web Application Server. These kinds of issues can be solved by setting this to the same host as defined in the Script location setting in QPR Configuration Manager. Name of the HTTP header variable that stores the login name of an authenticated user when using Single Sign On (SSO) authentication with QPR Portal
HOST_OVERRIDE
HDR_VAR_USR
String
12.5
This appendix describes the procedure required for changing the web server (e.g. from Microsoft IIS to Apache or vice versa) on which QPR Portal runs. 1. 2. 3. Run a modify installation and select to remove the QPR Portal Web Contents Run a modify installation again and select the QPR Portal Web Contents to be installed again. 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 contents folder is wwwroot. For Apache the default CGI binary folder is cgi-bin and the default web contents folder is htdocs. When the QPR Configuration Manager is launched after the installation, open the Web content
4.
141
Appendices
5. 6. 7.
8. 9.
tab under the QPR Web Application Server settings and verify that especially the script location setting uses the correct CGI binary folder name. In the case the web contents were installed under the root level of the web contents folder, the "Web content URL" setting can remain untouched. Go to the WAS plugins tab under the QPR Web Application Server settings, select SCPLUGIN and click the Configure button. Open the Web File Publishing tab and update the paths according to your new web server. 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 Vista and later versions) into a text editor. Search for WebContentPath setting (located in the WAS Settings section) and update its value to correspond with your new web server. 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 likely changed.
12.6
This chapter describes the audit logs which can be used to log selected operations in the servers of QPR applications. There are two types of audit logs available; audit logs, which record the changes made to values of elements and model operations, and user audit logs, which record the changes made to user rights.
142
Appendices
Event Section When an operation (action) is committed to the ScoreCard Application Server (or a Database Management System), a corresponding event will be written into the log file to the event section. The following actions are recorded: manual input of a new value manual change of a value manual delete of a value value inputted by a scheduled SQL import value inputted by a SQL mass import value inputted by an Olap import value inputted by an Olap mass import value changed by a scheduled SQL import value changed by a SQL mass import value changed by an Olap import value changed by an Olap mass import Calculated values are not recorded.
Note
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
143
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 ###
Warning
144
Appendices
<name of targeted group> Group object against whom the operation is performed <name of targeted element Element type against whom the type> operation is performed <grant> None Rights <grant> View Rights <grant> Update Rights <grant> Full Rights <revoke> Rights Changed element type rights
OBJECT NAME
145
Appendices
Format <grant> None Rights <grant> View Rights <grant> Update Rights <grant> Full Rights <revoke> Rights
The operations that are possible and appropriate to write are 'GRANT' and 'REVOKE'. These operations can be related to: ELEMENT TYPE RIGHT MODEL RIGHT OBJECT 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'
Demo User
View
Demo User
Financial Update
146
Appendices
Session timeout
CLIENT IP
147
Appendices
The possible operations to be recorded are 'GRANT' and 'REVOKE'. These operations can be related to the following actions: PROCESS LEVEL MODELING RIGHT
148
Appendices
16:07
PG model GRANT
Full name of new user Full name of new user Full name of new user Full name of new user
16:07
PG model GRANT
PG model Modify
16:07
PG model GRANT
sub-level
Modify
16:15
PG model GRANT
sub-level
View Only
149
Appendices
Field OPERATION
Format or value Grant/Revoke for permissions Add/Delete for objects <targeted user's name> <targeted group's name>
User object against whom the operation is performed Group object against whom the operation is performed
PGDC: QPR ProcessGuide Product object against which the operation is performed Development Client PGP: QPR ProcessGuide Web Client SCDC: QPR ScoreCard Development Client SCP: QPR ScoreCard Web Client PORTAL: QPR Portal UMS: QPR User Management System Basic/Administrate for Changed product permission PGDC, PGP, SCDC and SCP View/Update/ Administrate for PORTAL and UMS Inherit From Group Use System Administrator Use User Specific Changed product permission method
PERMISSION
If the full logging option is selected and the operation is made for a group to modify group specific permissions, separate log entries for each user (member of the group) are written to the log file. If the 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 the group's rights. Note that the user's group synchronization is done only when the user logs in to the system and the audit log reflects the current situation in the User Management System database, not necessarily the situation in NT or LDAP. Thus, the audit log may contain information that is not up-to-date but the information is automatically updated the next time the user logs in since the user is at that point removed from the old group(s) and added to the new one(s) and the audit log entries are written for this change.
16:00:42 16:00:42
11/19/07 11/19/07
qpr qpr
150
Appendices
TIME
DATE
USER LOGIN
USER NAME
TARGET GROUP
16:00:42 16:00:42
11/19/07 11/19/07
qpr qpr
Product Method Demo User Grant User new user Permissions Demo User Grant User new user Permissions
PRODUCT PERMISSI PRODUCT ON PERMISSI ON METHOD Specific PORTAL PGP Administrat e Basic -
12.7
This chapter describes some of the command line parameters for the QPR Transfertool database operations. 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 no way 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 into the 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> /dt_user:<username> /dt_pwd:<user's password>
/LOG:<location and The specific location and filename for the log created by Transfertool. If not name name of log file> specified, Transfertool will write a log into the <path to all users profile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case of Windows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1 \Logs /NOCONFIRM Do not ask for confirmations. /DEBUG:<location and Write a debug log file to the specified location. name name of log file> /SILENT Example
QPR. 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
151
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 into a file. Parameters /FILE:<location and name name of target file> /ds:<DB> /ds_user:<username> /ds_pwd:<user's password>
Source database name. Source database username. Source database user's password.
/LOG:<location and The specific location and filename for the log created by Transfertool. If not name name of log file> specified, Transfertool will write a log into the <path to all users profile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case of Windows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1 \Logs /NOCONFIRM /DEBUG: /SILENT Do not ask for confirmations Write a debug log file to the specified location. No UI is shown. When using this parameter, /NOCONFIRM is not needed.
/SKIP_SC_MODELS:<list A comma-separated list of QPR ScoreCard model ID's that are not written of model ID's> to the export file. Example
QPR. TransferTool. exe /export_FILE /FILE: \76. c: dat /ds: QPR_76_ACCESS_DEMO /ds_user: user / ds_pwd: password /LOG: \log. c: txt
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Import File
By starting QPR Transfertool with the /import_FILE parameter it is possible to import data from a file into a database. Note that it is possible to overwrite an existing database using this parameter! Parameters /FILE:<location and name name of source file> /dt:<DB> /dt_user:<username> /dt_pwd:<user's password> /LOG:<location and name name of log file>
Target database name. Target database username. Target database user's password. The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the <path to all users
152
Appendices
profile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case of Windows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1 \Logs /NOCONFIRM /DEBUG:<location and name name of log file> /SILENT /SKIP_SC_MODELS: <model ID's> Example
QPR. TransferTool. exe /import_FILE /FILE: \76. c: dat /dt: QPR_81_ACCESS_DEMO /dt_user: user / dt_pwd: password /LOG: \log. c: txt
Do not ask for confirmations. Write a debug log file to the specified location. No UI is shown. When using this parameter, /NOCONFIRM is not needed. A comma-separated list of QPR ScoreCard model ID's that should not be imported to the database from the import file.
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Target database name. Target database username. Target database user's password. The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the <path to all users profile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case of Windows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1 \Logs
Example
QPR. TransferTool. exe /MergePGAttributes /dt: QPR_81_ACCESS_DEMO /dt_user: user /dt_pwd: password /LOG: \log. c: txt
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
153
Appendices
You must also use /MODEL: parameter to specify whether you want the modification to target all models 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 of models, you must run Transfertool multiple times. Because the modification process loads all the targeted layouts to memory, it might be wise to run the operation one model at a time for large databases. You must also give one or both of the following parameters. They specify whether the operation targets custom graph layouts and/or graph layout templates: /CUSTOM_LAYOUTS /TEMPLATES Optional parameters /ONLY_INDICATORS
/ONLY_CHARTS
/SET_PERIOD:NONE|CURRENT|LATEST
/SET_SERIES:NONE
/CLEAR_PERIOD_LEVEL_LOCK
/SET_SERIES_LOCK
/CLEAR_SERIES_LOCK
If this parameter is given, then all the modifications are done only to items of following types: traffic lights indicator, icon indicator, linear gauge indicator, circular gauge indicator. If this parameter is given, then all the modifications are done only to items of following types: history chart. Sets the item's default period. Setting a specific period id is not supported. If this parameter is left unspecified, the default period of the items is not touched. Sets the item's default series. Setting a specific series is not supported. If this parameter is left unspecified, the default series of the items is not touched. Sets the 'lock to default' option on for layout items' default period. Sets the 'lock to default' option off for layout items' default period. Sets the 'lock to default' option on for layout items' default period level. In practice, this has only visible effects to items whose type is history chart. Sets the 'lock to default' option off for layout items' default period level. In practice, this has only visible effects to items whose type is history chart. Sets the 'lock to default' option on for layout items' default series. This has no effect to items of type history chart. Sets the 'lock to default' option on for layout items' default series. This has no effect to items of type history chart.
154
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 all models 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 in the model whose id is 1234567 in the Access demo database. The transfertool log will report the number of layouts processed and any error messages. Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Target database name. Target database username. Target database user's password. The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the <path to all users profile>\Application Data\QPR Software\QPR 8\8.1\Logs or in case of Windows Vista or a later version C:\ProgramData\QPR Software\QPR 8\8.1 \Logs
Example
QPR. TransferTool. exe /REPAIR_ACTION_PARENTS /dt: QPR_81_ACCESS_DEMO /dt_user: user /dt_pwd: password /LOG: \log. c: txt
155
References
13
[1] [2] [3] [4] [5] [6] [7]
References
QPR Software Plc web site, http://www.qpr.com/. QPR Customer Care, contact information available at http://www.qpr.com/support/. Adobe Systems Incorporated web site, http://www.adobe.com/ Microsoft Corporation web site, http://www.microsoft.com/ The Apache HTTP Server Project web site, http://httpd.apache.org/ Sniptools web site, http://sniptools.com/ QPR Developer's Guide, available on the QPR CD
156
Acknowledgements
14
Acknowledgements
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 following conditions 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 disclaimer in 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 products derived 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 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software utilizes the ANTLR 3 parser generator, Copyright (c) 2003-2007, Terence Parr All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions 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 disclaimer 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 derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Ninject assembly provided by Nate Kohari. Licensed under the Apache License 2.0.
157