Difference between revisions of "QPR UI System Settings"

From Mea Wiki
Jump to navigation Jump to search
Line 1: Line 1:
−
This page describes all QPR UI system settings stored in QPR UI's database in the '''CONFIGURATIONENTITY''' table. Some of the settings can be changed during the installation in the installation wizard, and all settings can be changed after the installation by changing them directly in the database. After these settings are changed in the database, QPR UI's Windows service must be restarted so that the changes take effect.
+
This page describes all QPR UI system settings stored in QPR UI database in the '''CONFIGURATIONENTITY''' table. Some of the settings can be changed during the installation in the installation wizard, and all settings can be changed after the installation by changing them directly in the database. After settings have been changed in the database, QPR UI 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.
+
The '''Setting name''' in the following tables is defined in the '''KEY_FIELD''' column of the CONFIGURATIONENTITY table.
  
−
= Settings Reference =
+
= System Settings =
 
== Settings for QPR Product Locations ==
 
== Settings for QPR Product Locations ==
  
Line 103: Line 103:
  
 
= Changing System Settings =
 
= Changing System Settings =
−
 
+
To change the system settings, you need to have access to QPR UI database.
−
TBA
+
# Open '''SQL Server Management Studio''' and login to the database server.
−
 
+
# Browse the QPR UI database and expand it. Expand '''Tables''', right click '''dbo.CONFIGURATIONENTITY''' and select '''Edit Top 200 Rows'''
−
# In the '''CONFIGURATIONENTITY''' table in the '''QPR UI database'''
+
# If the setting that needs to be changed, already exists, you can change the setting value in the '''VALUE_FIELD''' column. The change is save to the database right away, when the input field is defocused.
 +
# If you need to add a new setting, click the bottom row saying '''NULL'''.
 
# On the '''Server''' page of [[Glassfish_Configuration_in_QPR_UI|Glassfish Administration Console]], click '''Restart''' the server.
 
# On the '''Server''' page of [[Glassfish_Configuration_in_QPR_UI|Glassfish Administration Console]], click '''Restart''' the server.
  
 
[[Category: QPR UI]]
 
[[Category: QPR UI]]

Revision as of 08:43, 26 January 2018

This page describes all QPR UI system settings stored in QPR UI database in the CONFIGURATIONENTITY table. Some of the settings can be changed during the installation in the installation wizard, and all settings can be changed after the installation by changing them directly in the database. After settings have been changed in the database, QPR UI Windows service must be restarted so that the changes take effect.

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

System Settings

Settings for QPR Product Locations

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. See more about QPR UI permissions.
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.

Changing System Settings

To change the system settings, you need to have access to QPR UI database.

  1. Open SQL Server Management Studio and login to the database server.
  2. Browse the QPR UI database and expand it. Expand Tables, right click dbo.CONFIGURATIONENTITY and select Edit Top 200 Rows
  3. If the setting that needs to be changed, already exists, you can change the setting value in the VALUE_FIELD column. The change is save to the database right away, when the input field is defocused.
  4. If you need to add a new setting, click the bottom row saying NULL.
  5. On the Server page of Glassfish Administration Console, click Restart the server.
Retrieved from "https://wiki.onqpr.com/mea/index.php?title=QPR_UI_System_Settings&oldid=7894"