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

Revision as of 08:44, 19 April 2024

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
PUSH Settings
USAM Settings
Examples

CONTENT Settings

Area	Setting	Description
appSettings	UBIK.DataBase.ConnectionString	Configuration of the SQL connect string to the UBIK^® Database
appSettings	UBIK.Service.ValidityPeriod	Duration [in seconds] until a cached record is marked as outdated in the UBIK^® Kernel. Configuration of ValidityPeriod: Switch = -1 - cached objects are always valid. Switch = 0 - cache is always invalid and always checks the objects. Switch = +1 - cached objects are checked every 1+ seconds.
appSettings	UBIK.Service.LogLevel	To activate the Service logging, the LogLevel setting should be switched 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	ID of the language that must be used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language. Example Configuration of LanguageID: Switch = 0 - German. Switch = 1 - English.
appSettings	UBIK.Service.SessionManagementType	Configuration of the type session management the current service should use: Switch = 0 - Single Local Management. Switch = 1 - USAM Service
appSettings	UBIK.Service.SessionManagementUrl	In the case of SessionManagementType Switch is set to 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 Switch is set to 1, the URL of the PUSH Service can 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.

PUSH Settings

Area	Setting	Description
appSettings	UBIK.DataBase.ConnectionString	Configuration of the SQL connect string to the UBIK^® Database
appSettings	UBIK.Service.ValidityPeriod	Duration [in seconds] until a cached record is marked as outdated in the UBIK^® Kernel. Configuration of ValidityPeriod: Switch = -1 - cached objects are always valid. Switch = 0 - cache is always invalid and always checks the objects. Switch = +1 - cached objects are checked every 1+ seconds.
appSettings	UBIK.Service.TokenRestrictive	Configuration of TokenRestrictive: Switch = 0 - the token is not validated. Switch = 1 - data access is only possible after a successfull authentication.
appSettings	UBIK.Service.LogLevel	To activate The Service logging, the LogLevel setting should be switched 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.LanguageID	ID of the language that must be used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language. Example Configuration of LanguageID: Switch = 0 - German. Switch = 1 - English.
appSettings	UBIK.Service.SessionManagementType	Configuration of the type session management the current service should use: Switch = 0 - Single Local Management. Switch = 1 - USAM Service
appSettings	UBIK.Service.SessionManagementUrl	In the case of SessionManagementType Switch is set to 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.

USAM Settings

Area	Setting	Description
appSettings	UBIK.DataBase.ConnectionString	Configuration of the SQL connect string to the UBIK^® Database
appSettings	UBIK.Service.HideAuthenticationInfo	Authentication information error status Configuration of HideAuthenticationInfo: Switch = 0 - deliver error status if authentication fails. Switch = 1 - hide error status if authentication fails.
appSettings	UBIK.Service.ValidityPeriod	Duration [in seconds] until a cached record is marked as outdated in the UBIK^® Kernel. Configuration of ValidityPeriod: Switch = -1 - cached objects are always valid. Switch = 0 - cache is always invalid and always checks the objects. Switch = +1 - cached objects are checked every 1+ seconds.
appSettings	UBIK.Service.TokenValidityPeriod	Duration [in seconds] how long a token should be valid. For security reasons, it is recommended that the token validity should be set for short periods with a maximum of 24 Hours or 86400 seconds. Example Configuration of TokenValidityPeriod: Switch = 0 - token is indefinitely valid. Switch = 60 - token is valid for only 60 seconds. Switch = 3600 - token is valid for 1 hour.
appSettings	UBIK.Service.UserRestrictive	Authorization mechanism for user logins Configuraion of UserRestrictive: Switch = 0 - every login may connect. Switch = 1 - only known logins may connect to UBIK^®.
appSettings	UBIK.Service.DeviceRestrictive	Authorization mechanism for device logins Configuraion of DeviceRestrictive: Switch = 0 - every device may connect. Switch = 1- only known and active devices may connect to UBIK^®.
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 defines 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 59: / Line 59: @@
 | appSettings|| UBIK.DataBase.ConnectionString || Configuration of the SQL connect string to the {{UBIK}} Database
 |-
-| appSettings|| UBIK.Service.HideAuthenticationInfo|| '''Configuration of HideAuthenticationInfo:'''<br/>Switch = '''0''' - deliver error status if authentication fails.<br/>Switch = '''1''' - hide error status if authentication fails.
+| appSettings|| UBIK.Service.HideAuthenticationInfo|| Authentication information error status <br/>'''Configuration of HideAuthenticationInfo:'''<br/>Switch = '''0''' - deliver error status if authentication fails.<br/>Switch = '''1''' - hide error status if authentication fails.
 |-
 | appSettings|| UBIK.Service.ValidityPeriod || Duration [in seconds] until a cached record is marked as outdated in the {{UBIK}} Kernel. <br/> '''Configuration of ValidityPeriod:'''<br/> Switch = '''-1''' - cached objects are always valid. <br/> Switch = '''0''' - cache is always invalid and always checks the objects. <br/> Switch = '''+1''' - cached objects are checked every 1+ seconds.
@@ Line 65: / Line 65: @@
 | appSettings|| UBIK.Service.TokenValidityPeriod || Duration [in seconds] how long a token should be valid. For security reasons, it is recommended that the token validity should be set for short periods with a maximum of 24 Hours or 86400 seconds.<br/> '''Example Configuration of TokenValidityPeriod:'''<br/> Switch = '''0''' - token is indefinitely valid.<br/> Switch = '''60''' - token is valid for only 60 seconds. <br/> Switch = '''3600''' - token is valid for 1 hour.
 |-
-| appSettings|| UBIK.Service.UserRestrictive || '''Configuraion of UserRestrictive:'''<br/>Switch = '''0''' - every login may connect.<br/>Switch = '''1''' - only known logins may connect to {{UBIK}}.<br/>
+| appSettings|| UBIK.Service.UserRestrictive || Authorization mechanism for user logins<br/>'''Configuraion of UserRestrictive:'''<br/>Switch = '''0''' - every login may connect.<br/>Switch = '''1''' - only known logins may connect to {{UBIK}}.<br/>
 |-
-| appSettings|| UBIK.Service.DeviceRestrictive || '''Configuraion of DeviceRestrictive:'''<br/>Switch = '''0''' - every device may connect.<br/>Switch = '''1'''- only known and active devices may connect to {{UBIK}}.
+| appSettings|| UBIK.Service.DeviceRestrictive || Authorization mechanism for device logins <br/>'''Configuraion of DeviceRestrictive:'''<br/>Switch = '''0''' - every device may connect.<br/>Switch = '''1'''- only known and active devices may connect to {{UBIK}}.
 |-
 | 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 defines the interval for the Rights Evaluator.
 |-
 |}
+[[Category:Installing|Configuration Files/AppSettings.config]]
+[[Category:Web service|Configuration Files/AppSettings.config]]
 = Examples =