Difference between revisions of "QPR UI System Settings"

From Mea Wiki
Jump to navigation Jump to search
m
m
Line 2: Line 2:
  
 
The '''Setting name''' in the following table is defined in the '''KEY_FIELD''' column of the CONFIGURATIONENTITY table.
 
The '''Setting name''' in the following table is defined in the '''KEY_FIELD''' column of the CONFIGURATIONENTITY table.
 +
 +
 +
== External Service Settings ==
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 7: Line 10:
 
!|Description
 
!|Description
 
|-
 
|-
−
|[[Permissions (QPR UI)#Defining the administrators group|ADMINISTRATORS_GROUP_NAME]]
+
|MEA_SERVICE_LOCATION
−
|QPR Suite (MEA) or QPR ProcessAnalyzer user group name which member users are administrators in QPR UI. Other users have only viewer rights.
+
|QPR Suite web service interface location. QPR UI uses this address to access QPR Suite to fetch data. In usual configurations, where QPR Suite is in the same server computer, the address is '''<nowiki>http://localhost/QPR2017-1/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/</nowiki>'''. Note that you may need to change the QPR Suite version number in the url or the protocol (http/https).
 
|-
 
|-
−
|[[Common QPR Authentication#Configuring Common Authentication for QPR UI|AUTHENTICATION_SERVICES]]
+
|PA_SERVICE_LOCATION
−
|This setting is used to configure '''Common QPR Authentication''' to QPR UI. You can find more information by clicking the setting name.
+
|QPR ProcessAnalyzer web service interface location. QPR UI uses this address to access QPR ProcessAnalyzer to fetch data.
−
|-
 
−
|DB_VERSION
 
−
|QPR UI database version. Do not edit this field.
 
−
|-
 
−
|[[Federated Authentication in QPR UI#Common configuration entries|FEDERATEDLY_MANAGED_GROUPS]]
 
−
|List of user groups that the federated authentication syncronizes for a user when the user logs in to QPR UI.
 
 
|-
 
|-
−
|QPR_REPORTING_EXPRESSIONS_WEB_SERVICE_LOCATION
+
|QPR_REPORTING_EXPRESSIONS_<wbr />WEB_SERVICE_LOCATION
 
|QPR Reporting Add-on Web Service interface location for datasets. QPR UI uses this location to query to [[QPR Reporting Expression]] datasource. In usual configurations, the following setting can be used: '''<nowiki>http://localhost/QPRWebServicesExtensions/ExpressionAsDataset.ashx?xsession=<#meaSessionId>&expression=<#expression></nowiki>''' (it may also be '''https''').
 
|QPR Reporting Add-on Web Service interface location for datasets. QPR UI uses this location to query to [[QPR Reporting Expression]] datasource. In usual configurations, the following setting can be used: '''<nowiki>http://localhost/QPRWebServicesExtensions/ExpressionAsDataset.ashx?xsession=<#meaSessionId>&expression=<#expression></nowiki>''' (it may also be '''https''').
  
Line 28: Line 25:
  
 
These tags can be used to fill the needed values for "xsession" and "expression" parameters
 
These tags can be used to fill the needed values for "xsession" and "expression" parameters
 +
|}
 +
 +
== Security Settings ==
 +
{| class="wikitable"
 +
!|Setting&nbsp;name (KEY_FIELD column)
 +
!|Description
 
|-
 
|-
−
|MEA_SERVICE_LOCATION
+
|[[Common QPR Authentication#Configuring Common Authentication for QPR UI|AUTHENTICATION_SERVICES]]
−
|QPR Suite web service interface location. QPR UI uses this address to access QPR Suite to fetch data. In usual configurations, where QPR Suite is in the same server computer, the address is '''<nowiki>http://localhost/QPR2017-1/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/</nowiki>'''. Note that you may need to change the QPR Suite version number in the url or http/https.
+
|This setting is used to configure '''Common QPR Authentication''' to QPR UI. You can find more information by clicking the setting name.
 +
|-
 +
|[[Permissions (QPR UI)#Defining the administrators group|ADMINISTRATORS_GROUP_NAME]]
 +
|QPR Suite (MEA) or QPR ProcessAnalyzer user group name which member users are administrators in QPR UI. Other users have only viewer rights.
 +
|-
 +
|[[Common QPR Authentication#QPR UI Session Expiration|SESSION_EXPIRATION_TIME]]
 +
|QPR UI user session expiration time in minutes. If this setting is not defined, by default this is 30 minutes.
 +
|}
 +
 
 +
== Federated (SAML) Authentication Settings ==
 +
{| class="wikitable"
 +
!|Setting&nbsp;name (KEY_FIELD column)
 +
!|Description
 
|-
 
|-
−
|PA_SERVICE_LOCATION
+
|[[Federated Authentication in QPR UI#Common configuration entries|FEDERATEDLY_MANAGED_GROUPS]]
−
|QPR ProcessAnalyzer web service interface location. QPR UI uses this address to access QPR ProcessAnalyzer to fetch data.
+
|List of user groups that the federated authentication syncronizes for a user when the user logs in to QPR UI.
 
|-
 
|-
 
|[[Federated Authentication in QPR UI#Common configuration entries|SAML_AUTOMATIC_LOGIN]]
 
|[[Federated Authentication in QPR UI#Common configuration entries|SAML_AUTOMATIC_LOGIN]]
Line 68: Line 83:
 
|Federated authentication setting, described in the linked page.
 
|Federated authentication setting, described in the linked page.
 
|-
 
|-
−
|SCHEMA_VERSION
+
|SYSTEM_USER_NAME
−
|QPR UI database schema version. Do not edit this field.
+
|QPR Suite and QPR ProcessAnalyzer administrator username. This setting is needed so that QPR UI is able to login to QPR Suite and QPR ProcessAnalyzer to set user information when the [[Federated Authentication in QPR UI|federated authentication]] is in use. Note that if you have both QPR Suite and QPR ProcessAnalyzer in use, they must use the same user account and password.
 
|-
 
|-
−
|[[Common QPR Authentication#QPR UI Session Expiration|SESSION_EXPIRATION_TIME]]
+
|SYSTEM_USER_PASSWORD
−
|QPR UI user session expiration time in minutes. If this setting is not defined, by default this is 30 minutes.
+
|Password of the QPR Suite and QPR ProcessAnalyzer administrator username defined in SYSTEM_USER_NAME field. This setting is needed only when the [[Federated Authentication in QPR UI|federated authentication]] is in use. Note that if you have both QPR Suite and QPR ProcessAnalyzer in use, they must use the same user account and password.
 +
|}
 +
 
 +
==Other settings ==
 +
{| class="wikitable"
 +
!|Setting&nbsp;name (KEY_FIELD column)
 +
!|Description
 
|-
 
|-
−
|SYSTEM_USER_NAME
+
|DB_VERSION
−
|QPR Suite (MEA) system username. Used in the federated authentication.
+
|QPR UI database version. Do not edit this field.
 
|-
 
|-
−
|SYSTEM_USER_PASSWORD
+
|SCHEMA_VERSION
−
|Password of the QPR Suite (MEA) system user defined in SYSTEM_USER_NAME field.
+
|QPR UI database schema version. Do not edit this field.
 
|}
 
|}
  
 
[[Category: QPR UI]]
 
[[Category: QPR UI]]

Revision as of 09:59, 15 December 2017

This page describes all QPR UI system settings. The settings are stored in QPR UI's database in the CONFIGURATIONENTITY table. Some of the settings can be changed during the installation in the installation wizard. After these settings are changed in the database, QPR UI's Windows service must be restarted so that the changes take effect.

The Setting name in the following table is defined in the KEY_FIELD column of the CONFIGURATIONENTITY table.


External Service Settings

Setting name (KEY_FIELD column) Description
MEA_SERVICE_LOCATION QPR Suite web service interface location. QPR UI uses this address to access QPR Suite to fetch data. In usual configurations, where QPR Suite is in the same server computer, the address is http://localhost/QPR2017-1/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/. Note that you may need to change the QPR Suite version number in the url or the protocol (http/https).
PA_SERVICE_LOCATION QPR ProcessAnalyzer web service interface location. QPR UI uses this address to access QPR ProcessAnalyzer to fetch data.
QPR_REPORTING_EXPRESSIONS_WEB_SERVICE_LOCATION QPR Reporting Add-on Web Service interface location for datasets. QPR UI uses this location to query to QPR Reporting Expression datasource. In usual configurations, the following setting can be used: http://localhost/QPRWebServicesExtensions/ExpressionAsDataset.ashx?xsession=<#meaSessionId>&expression=<#expression> (it may also be https).

Advanced details: This setting support following tags which are replaced when the setting is used by QPR UI:

  • <#expression>: Contains the expression that is sent to the web service.
  • <#meaSessionId>: Contains the QPR Suite session id.
  • <#enticeSessionId>: Contains the QPR UI session id.

These tags can be used to fill the needed values for "xsession" and "expression" parameters

Security Settings

Setting name (KEY_FIELD column) Description
AUTHENTICATION_SERVICES This setting is used to configure Common QPR Authentication to QPR UI. You can find more information by clicking the setting name.
ADMINISTRATORS_GROUP_NAME QPR Suite (MEA) or QPR ProcessAnalyzer user group name which member users are administrators in QPR UI. Other users have only viewer rights.
SESSION_EXPIRATION_TIME QPR UI user session expiration time in minutes. If this setting is not defined, by default this is 30 minutes.

Federated (SAML) Authentication Settings

Setting name (KEY_FIELD column) Description
FEDERATEDLY_MANAGED_GROUPS List of user groups that the federated authentication syncronizes for a user when the user logs in to QPR UI.
SAML_AUTOMATIC_LOGIN Federated authentication setting, described in the linked page.
SAML_CONSUMER_URL Federated authentication setting, described in the linked page.
SAML_METADATA_URL Federated authentication setting, described in the linked page.
SAML_REDIRECT_URL Federated authentication setting, described in the linked page.
SAML_SERVER_ENTITY_IDENTIFIER Federated authentication setting, described in the linked page.
SAML_SIGNING_CERTIFICATE Federated authentication setting, described in the linked page.
SAML_USER_DESCRIPTION_ATTRIBUTE Federated authentication setting, described in the linked page.
SAML_USER_EMAIL_ATTRIBUTE Federated authentication setting, described in the linked page.
SAML_USER_FULLNAME_ATTRIBUTE Federated authentication setting, described in the linked page.
SAML_USER_GROUPS_ATTRIBUTE Federated authentication setting, described in the linked page.
SAML_USER_ID_ATTRIBUTE Federated authentication setting, described in the linked page.
SYSTEM_USER_NAME QPR Suite and QPR ProcessAnalyzer administrator username. This setting is needed so that QPR UI is able to login to QPR Suite and QPR ProcessAnalyzer to set user information when the federated authentication is in use. Note that if you have both QPR Suite and QPR ProcessAnalyzer in use, they must use the same user account and password.
SYSTEM_USER_PASSWORD Password of the QPR Suite and QPR ProcessAnalyzer administrator username defined in SYSTEM_USER_NAME field. This setting is needed only when the federated authentication is in use. Note that if you have both QPR Suite and QPR ProcessAnalyzer in use, they must use the same user account and password.

Other settings

Setting name (KEY_FIELD column) Description
DB_VERSION QPR UI database version. Do not edit this field.
SCHEMA_VERSION QPR UI database schema version. Do not edit this field.
Retrieved from "https://wiki.onqpr.com/mea/index.php?title=QPR_UI_System_Settings&oldid=7326"