QPR Reporting Add-on - Revision history

Ollvihe at 11:53, 4 June 2024

2024-06-04T11:53:50Z

Ollvihe at 21:28, 30 May 2024

2024-05-30T21:28:08Z

Ollvihe at 21:23, 30 May 2024

2024-05-30T21:23:54Z

Ollvihe at 21:23, 30 May 2024

2024-05-30T21:23:11Z

Ollvihe at 21:22, 30 May 2024

2024-05-30T21:22:34Z

Ollvihe at 21:21, 30 May 2024

2024-05-30T21:21:41Z

TeeSiip: 201X to 20XX

2022-03-08T13:05:19Z

201X to 20XX

Show changes

Ollvihe: /* Installation */

2022-02-24T15:08:15Z

Installation

Ollvihe: /* Installation */

2022-02-24T15:07:52Z

Installation

Ollvihe: /* Installation */

2022-02-24T15:06:23Z

Installation

@@ Line 61: / Line 61: @@
 . Configure QPR Reporting Add-on settings listed in the [[#Web.config_File_Settings|Settings]] section. The settings are located in the '''C:\inetpub\wwwroot\QPRWebServicesExtensions\web.config''' file in the '''appSettings''' section. Quick guide for usual configurations (file '''C:\inetpub\wwwroot\QPRWebServicesExtensions\web.config'''):
 * a. When Windows authentication is not in use and [[Common QPR Authentication]] is used: '''wcfsecuritymode=none''' and '''qprauthenticationmode=commonqprauthentication'''
-* b. When Windows authentication is not in use without Common QPR Authentication: '''wcfsecuritymode=none''' and '''qprauthenticationmode=passedsession'''
+* b. When Windows authentication is in use: '''wcfsecuritymode=message''' and '''qprauthenticationmode=windows'''
 . Make a backup copy of the '''C:\Program Files\QPR Software Plc\QPR 20XX.1 Servers\WebServices\servicetester.aspx''' file. Replace the file with the '''servicetester.aspx.''' file from the installation package.
@@ Line 139: / Line 138: @@
 ||Determines how the Reporting Add-on authenticates users to QPR Web Service. There are following options:
 * '''windows''': Windows user making the request is used to authenticate to QPR Web Service. It’s advisable to use this authentication method if available. If the session id is provided (in the xsession parameter) while the windows authentication mode is used, the provided session id is not used. When this option is used, ''wcfsecuritymode'' must be ''message''. Note that when using QPR Reporting Add-on with QPR UI, the setting cannot be used, because QPR UI connects to the Reporting Add-on using the user account which runs the Payara web server (not the person's user account).
-* '''commonqprauthentication''': [[Common_QPR_Authentication|Common QPR authentication]] is a mechanism where QPR products have been configured to trust each other in a way that when a user is authenticated to one of the products, the user is also authenticated to other QPR products as well. When common QPR authentication is in use, session id of the source QPR system is passed as a parameter to the Reporting Add-on. Note that the session id doesn't need to be the QPR Web Service session id, but the session id of any QPR product may be used. The ''xsession'' parameter is used to pass the common authentication session id. This options can be used when ''wcfsecuritymode'' is either ''none'' or ''message''. Also the token authentication introduced in QPR Suite 2019.1 works with the ''commonqprauthentication'' setting. Note also that the isn't any more the ''passedsession'' setting, but the ''commonqprauthentication'' settings also covers that usecase.
+* '''commonqprauthentication''': [[Common_QPR_Authentication|Common QPR authentication]] is a mechanism where QPR products have been configured to trust each other in a way that when a user is authenticated to one of the products, the user is also authenticated to other QPR products as well. When common QPR authentication is in use, session id of the source QPR system is passed as a parameter to the Reporting Add-on. Note that the session id doesn't need to be the QPR Web Service session id, but the session id of any QPR product may be used. The ''xsession'' parameter is used to pass the common authentication session id. This options can be used when ''wcfsecuritymode'' is either ''none'' or ''message''. Also the token authentication introduced in QPR Suite 2019.1 works with the ''commonqprauthentication'' setting.
 * '''fixedcredentials''': The defined user account is used for all access to QPR Web Service. The account's username and password are defined in the configuration (see settings username and password). Note that from the data security point of view this is not the best option, because users running the reports may see data that they don't see in their own account. If the session id is provided (in the xsession parameter), when the fixedcredentials authentication mode is used, the provided session id is used instead of authenticating using the fixed credentials. This options can be used when ''wcfsecuritymode'' is either ''none'' or ''message''.
 |- style="vertical-align:top;"

@@ Line 10: / Line 10: @@
 Follow these steps to install QPR Reporting Add-on. Installation package is available in the [[QPR_Product_Downloads#QPR_Reporting_Add-on|downloads page]].
-Note that there are different folder paths for each QPR Suite version. These instructions use X in the folder names, that should be replaced by the version of the used QPR Suite.
+Note that there are different folder paths for each QPR Suite version. These instructions use X in the folder names which should be replaced with the actual QPR Suite version.
-. Check whether the QPR environment uses '''Windows authentication''' (IWA) and/or '''HTTPS connection'''. Windows authentication is used when QPR system is connected to LDAP/AD and Windows user accounts are used to login to QPR. When [[QPR UI Wiki|QPR UI]] is in use, Windows authentication cannot be used for QPR Web Service. HTTPS connection is in use when QPR Portal url starts with ''https''.
+. Check whether the QPR environment uses '''Windows authentication''' (IWA) and/or '''HTTPS connection'''. Windows authentication is used when QPR system is connected to LDAP/AD and Windows user accounts are used to login to QPR. HTTPS connection is in use when QPR Portal url starts with ''https''.
 . Open '''Programs and Features''' (in Windows '''Control Panel''') and click '''Turn Windows features on or off'''. Check that components listed in the following table are installed. The installation procedure depends on Windows version. QPR Reporting Add-on needs '''.Net Framework 4.6.1''' or later version.
@@ Line 39: / Line 39: @@
 |}
-. This step is for checking the QPR Suite has been configured properly. Note that this step is about configuring QPR Suite (not QPR Reporting Add-on which also has a web.config file). Check that QPR Web Services web.config file is a proper one (located in '''C:\Program Files\QPR Software Plc\QPR 20XX.1''' '''Servers\WebServices'''). In the default QPR installation there are files '''web.config''' and '''web.config.IWA'''. If QPR environment uses Windows authentication (refer to step 1), the latter file must be taken into use by renaming
+. (This step is for checking the QPR Suite has been configured properly.) Check that QPR Web Services web.config file is a proper one (located in '''C:\Program Files\QPR Software Plc\QPR 20XX.1''' '''Servers\WebServices'''). In the default QPR installation, there are files '''web.config''' and '''web.config.IWA'''. If QPR environment uses Windows authentication (refer to step 1), the latter file must be taken into use by renaming
 * '''web.config''' to '''web.config.noIWA''', and
 * '''web.config.IWA''' to '''web.config'''.
-. This step is for checking the QPR Suite has been configured properly. If using Windows authentication (refer to step 1), make sure '''C:\ProgramData\QPR Software\QPR 20XX\20XX.1\Servers\Settings\QPR_Servers.ini''' has settings '''IWACGIBinaryHost=127.0.0.1''' and '''CGIBinaryHost=127.0.0.1.''' under '''WAS Settings''' section.
+. (This step is for checking the QPR Suite has been configured properly.) If using Windows authentication (refer to step 1), make sure '''C:\ProgramData\QPR Software\QPR 20XX\20XX.1\Servers\Settings\QPR_Servers.ini''' has settings '''IWACGIBinaryHost=127.0.0.1''' and '''CGIBinaryHost=127.0.0.1.''' under '''WAS Settings''' section.
 . Common QPR authentication needs to be configured (to establish common authentication between QPR Suite WAS and WS). Follow these instructions: [[Common_QPR_Authentication#Configuring_Common_Authentication_for_QPR_Suite_Portal_and_QPR_Suite_Web_Service|Configuring Common Authentication for QPR Suite Portal and QPR Suite Web Service]].

@@ Line 45: / Line 45: @@
 . This step is for checking the QPR Suite has been configured properly. If using Windows authentication (refer to step 1), make sure '''C:\ProgramData\QPR Software\QPR 20XX\20XX.1\Servers\Settings\QPR_Servers.ini''' has settings '''IWACGIBinaryHost=127.0.0.1''' and '''CGIBinaryHost=127.0.0.1.''' under '''WAS Settings''' section.
-. If using QPR Suite 2019.1, common QPR authentication needs to be configured (to establish common authentication between QPR Suite WAS and WS). Follow these instructions: [[Common_QPR_Authentication#Configuring_Common_Authentication_for_QPR_Suite_Portal_and_QPR_Suite_Web_Service|Configuring Common Authentication for QPR Suite Portal and QPR Suite Web Service]].
+. Common QPR authentication needs to be configured (to establish common authentication between QPR Suite WAS and WS). Follow these instructions: [[Common_QPR_Authentication#Configuring_Common_Authentication_for_QPR_Suite_Portal_and_QPR_Suite_Web_Service|Configuring Common Authentication for QPR Suite Portal and QPR Suite Web Service]].
 . Copy '''QPRWebServicesExtensions''' folder from installation package to IIS published files in '''C:\inetpub\wwwroot\'''.

@@ Line 137: / Line 137: @@
 |- style="vertical-align:top;"
 |qprauthenticationmode
-||Determines how the Reporting Add-on authenticates users to QPR Web Service. When using QPR Suite 2019.1, options are as follows:
+||Determines how the Reporting Add-on authenticates users to QPR Web Service. There are following options:
 * '''windows''': Windows user making the request is used to authenticate to QPR Web Service. It’s advisable to use this authentication method if available. If the session id is provided (in the xsession parameter) while the windows authentication mode is used, the provided session id is not used. When this option is used, ''wcfsecuritymode'' must be ''message''. Note that when using QPR Reporting Add-on with QPR UI, the setting cannot be used, because QPR UI connects to the Reporting Add-on using the user account which runs the Payara web server (not the person's user account).
 * '''commonqprauthentication''': [[Common_QPR_Authentication|Common QPR authentication]] is a mechanism where QPR products have been configured to trust each other in a way that when a user is authenticated to one of the products, the user is also authenticated to other QPR products as well. When common QPR authentication is in use, session id of the source QPR system is passed as a parameter to the Reporting Add-on. Note that the session id doesn't need to be the QPR Web Service session id, but the session id of any QPR product may be used. The ''xsession'' parameter is used to pass the common authentication session id. This options can be used when ''wcfsecuritymode'' is either ''none'' or ''message''. Also the token authentication introduced in QPR Suite 2019.1 works with the ''commonqprauthentication'' setting. Note also that the isn't any more the ''passedsession'' setting, but the ''commonqprauthentication'' settings also covers that usecase.

@@ Line 140: / Line 140: @@
 * '''windows''': Windows user making the request is used to authenticate to QPR Web Service. It’s advisable to use this authentication method if available. If the session id is provided (in the xsession parameter) while the windows authentication mode is used, the provided session id is not used. When this option is used, ''wcfsecuritymode'' must be ''message''. Note that when using QPR Reporting Add-on with QPR UI, the setting cannot be used, because QPR UI connects to the Reporting Add-on using the user account which runs the Payara web server (not the person's user account).
 * '''commonqprauthentication''': [[Common_QPR_Authentication|Common QPR authentication]] is a mechanism where QPR products have been configured to trust each other in a way that when a user is authenticated to one of the products, the user is also authenticated to other QPR products as well. When common QPR authentication is in use, session id of the source QPR system is passed as a parameter to the Reporting Add-on. Note that the session id doesn't need to be the QPR Web Service session id, but the session id of any QPR product may be used. The ''xsession'' parameter is used to pass the common authentication session id. This options can be used when ''wcfsecuritymode'' is either ''none'' or ''message''. Also the token authentication introduced in QPR Suite 2019.1 works with the ''commonqprauthentication'' setting. Note also that the isn't any more the ''passedsession'' setting, but the ''commonqprauthentication'' settings also covers that usecase.
 * '''fixedcredentials''': The defined user account is used for all access to QPR Web Service. The account's username and password are defined in the configuration (see settings username and password). Note that from the data security point of view this is not the best option, because users running the reports may see data that they don't see in their own account. If the session id is provided (in the xsession parameter), when the fixedcredentials authentication mode is used, the provided session id is used instead of authenticating using the fixed credentials. This options can be used when ''wcfsecuritymode'' is either ''none'' or ''message''.
 |- style="vertical-align:top;"

@@ Line 37: / Line 37: @@
 ** '''.Net Framework 4.5 Advanced Services > WCF Services > HTTP Activation'''
 [[file:windows 8 features.jpg]]
 |}

@@ Line 127: / Line 127: @@
 . Restart Windows service for QPR Suite, or clear QPR Portal templates cache ('''<nowiki>http://SERVERNAME/QPR201X-1/Portal/QPR.Isapi.dll?QPRWAS&*cleartemplatecache</nowiki>'''). In addition, clear web browser’s cache.
-. Check that the [Enable_Detailed_Error_Messages_in_IIS|detailed error message are enabled in IIS].
+. Check that the [[Enable_Detailed_Error_Messages_in_IIS|detailed error message are enabled in IIS]].
 === Web.config File Settings ===

@@ Line 46: / Line 46: @@
 ** '''.Net Framework 4.5 Features > ASP.NET 4.5 .Net Framework 4.5 Features > WCF Services > HTTP Activation'''
 [[File:Windows server 2012.jpg]]
 |}