Difference between revisions of "Configuration Files/AppSettings.config"

Revision as of 21:00, 5 May 2025

The data and session management service of the web service are configured in this file.

SessionManagementType has to be of Local Application Service always!

CONTENT Settings

Area	Setting	Description
appSettings	UBIK.DataBase.ConnectionString	Configuration of the Microsoft SQL Server connect string to the UBIK^® Database.
appSettings	UBIK.Service.ValidityPeriod	The duration [in seconds] until a cached record is marked as outdated in the UBIK^® Kernel. Configuration of ValidityPeriod: Switch = -1 - cached objects are valid indefinitely. Switch = 0 - cache is always invalid and will get constantly updated. Switch = +1 - cached objects are checked every 1+ seconds.
appSettings	UBIK.Service.LogLevel	To enable logging the LogLevel must be set to Verbose in the Logging.config and also the switch for the LogLevel in the AppSettings.config should be adapted accordingly. Configuration of LogLevel switch in AppSettings.config: Switch = 0 - No logging. Switch = 10 - Simple logging. Switch = 20 - Detailed logging.
appSettings	UBIK.Service.TokenRestrictive	Validation of the used Token Configuration of TokenRestrictive: Switch = 0 - the token is not validated. Switch = 1 - data access is only possible after a successfull authentication.
appSettings	UBIK.Service.LanguageID	Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language.
appSettings	UBIK.Service.SessionManagementType	Configuration of the type session management the current service will use: Switch = 0 - Single Local Management. Switch = 1 - USAM Service.
appSettings	UBIK.Service.SessionManagementUrl	In the case of SessionManagementType = 1, the URL of the USAM Service must be configured using this setting. If a port other than 443 (default port for https) is used, it has to be specified here as well.
appSettings	UBIK.Service.PushServiceUrl	In the case of SessionManagementType = 1, the URL of the PUSH Service must be configured using this setting..If a port other than 443 (default port for https) is used, it has to be specified here as well.
appSettings	UBIK.Service.GroupRightsUpdateIntervall	GroupRightsUpdateIntervall setting is optional. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValidityPeriod is used for defining the interval for the Rights Evaluator.
appSettings	UBIK.Service.EnableChangeNotifications	Whether or not to react to changes made by other processes, e.g., for updating the user group cache if necessary. 1 = change detection enabled, 0 = no change detection.

PUSH Settings

Area	Setting	Description
appSettings	UBIK.DataBase.ConnectionString	Configuration of the Microsoft SQL Server connect string to the UBIK^® Database.
appSettings	UBIK.Service.ValidityPeriod	The duration [in seconds] until a cached record is marked as outdated in the UBIK^® Kernel. Configuration of ValidityPeriod: Switch = -1 - cached objects are valid indefinitely. Switch = 0 - cache is always invalid and will get constantly updated. Switch = +1 - cached objects are checked every 1+ seconds.
appSettings	UBIK.Service.LogLevel	To enable logging the LogLevel must be set to Verbose in the Logging.config and also the switch for the LogLevel in the AppSettings.config should be adapted accordingly. Configuration of LogLevel switch in AppSettings.config: Switch = 0 - No logging. Switch = 10 - Simple logging. Switch = 20 - Detailed logging.
appSettings	UBIK.Service.TokenRestrictive	Validation of the used Token Configuration of TokenRestrictive: Switch = 0 - the token is not validated. Switch = 1 - data access is only possible after a successfull authentication.
appSettings	UBIK.Service.LanguageID	Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language.
appSettings	UBIK.Service.SessionManagementType	Configuration of the type session management the current service will use: Switch = 0 - Single Local Management. Switch = 1 - USAM Service.
appSettings	UBIK.Service.SessionManagementUrl	In the case of SessionManagementType = 1, the URL of the USAM Service must be configured using this setting. If a port other than 443 (default port for https) is used, it has to be specified here as well.
appSettings	UBIK.Service.GroupRightsUpdateIntervall	GroupRightsUpdateIntervall setting is optional. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValidityPeriod is used for defining the interval for the Rights Evaluator.

Examples

Example CONTENT

Example PUSH

Example USAM

Example CONTENT Windows Azure

Configuration for a Microsoft Azure cloud database and a LAS service.

Example CONTENT Windows Authentication

Integrated security.

The port number myport must be specified only if other than 443.

@@ Line 26: / Line 26: @@
 |-
 | appSettings|| UBIK.Service.GroupRightsUpdateIntervall || '''GroupRightsUpdateIntervall setting is optional'''. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValidityPeriod is used for defining the interval for the Rights Evaluator.
+|-
+| appSettings|| UBIK.Service.EnableChangeNotifications || Whether or not to react to changes made by other processes, e.g., for updating the user group cache if necessary. 1 = change detection enabled, 0 = no change detection. {{Version/ServerSince|4.9.0}}
 |-
 |}
 = PUSH Settings =
@@ Line 52: / Line 51: @@
 |-
 | appSettings|| UBIK.Service.GroupRightsUpdateIntervall || '''GroupRightsUpdateIntervall setting is optional'''. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValidityPeriod is used for defining the interval for the Rights Evaluator.
-|-
-| appSettings|| UBIK.Service.EnableChangeNotifications || Whether or not to react to changes made by other processes, e.g., for updating the user group cache if necessary. 1 = change detection enabled, 0 = no change detection. {{Version/ServerSince|4.9.0}}
 |-
 |}