Difference between revisions of "Configuration Files/AppSettings.config"
Line 3: | Line 3: | ||
{{Attention|SessionManagementType has to be of ''Local Application Service'' always! {{Version/ServerSince|2.4.3}}}} | {{Attention|SessionManagementType has to be of ''Local Application Service'' always! {{Version/ServerSince|2.4.3}}}} | ||
− | = Settings = | + | = CONTENT Settings = |
{| class="wikitable" | width = "88%" | {| class="wikitable" | width = "88%" | ||
Line 9: | Line 9: | ||
! Area!! Setting!! Description | ! Area!! Setting!! Description | ||
|- | |- | ||
− | | appSettings|| UBIK.DataBase.ConnectionString ||Configuration of the SQL connect string to the {{UBIK}} Database | + | | appSettings|| UBIK.DataBase.ConnectionString || Configuration of the SQL connect string to the {{UBIK}} Database |
|- | |- | ||
− | | appSettings|| UBIK.Service.ValidityPeriod || | + | | 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. |
− | Duration [in seconds] until a cached record is marked as outdated in the {{UBIK}} Kernel | + | |
|- | |- | ||
− | | appSettings|| UBIK.Service.LogLevel || | + | | appSettings|| UBIK.Service.LogLevel || To activate the Service logging, the LogLevel setting should be switched to '''Verbose''' in the [[Logging#How_To_Configure_Logging]].config and also the switch for the LogLevel in the AppSettings.config should be adapted accordingly. <br/> '''Configuration of LogLevel switch in AppSettings.config:'''<br/>Switch = '''0''' - No logging. <br/>Switch = '''10''' - Simple logging.<br/>Switch = '''20''' - Detailed logging. |
|- | |- | ||
− | | appSettings|| UBIK.Service. | + | | appSettings|| UBIK.Service.TokenRestrictive || Validation of the used Token <br/>'''Configuration of TokenRestrictive:'''<br/>Switch = '''0''' - the token is not validated.<br/>Switch = '''1''' - data access is only possible after a successfull authentication. |
|- | |- | ||
− | | appSettings|| UBIK.Service. | + | | 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.<br/> '''Example Configuration of LanguageID:'''<br/>Switch = '''0''' - German.<br/>Switch = '''1''' - English. |
|- | |- | ||
− | | appSettings|| UBIK.Service. | + | | appSettings|| UBIK.Service.SessionManagementType || '''Configuration of the type [[USAM|session management]] the current service should use:'''<br/>Switch = '''0''' - Single Local Management.<br/>Switch = '''1''' - USAM Service |
|- | |- | ||
− | | appSettings|| UBIK.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.<br/>'''If a port other than 443 (default port for https) is used, it has to be specified here as well.''' |
|- | |- | ||
− | | appSettings|| UBIK.Service. | + | | 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. | + | | 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 = | ||
+ | {| class="wikitable" | width = "88%" | ||
|- | |- | ||
− | | appSettings|| UBIK.Service. | + | ! 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. <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. | ||
+ | |- | ||
+ | | appSettings|| UBIK.Service.TokenRestrictive || '''Configuration of TokenRestrictive:'''<br/>Switch = '''0''' - the token is not validated.<br/>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#How_To_Configure_Logging]].config and also the switch for the LogLevel in the AppSettings.config should be adapted accordingly. <br/> '''Configuration of LogLevel switch in AppSettings.config:'''<br/>Switch '''0''' - No logging. <br/>Switch '''10''' - Simple logging.<br/>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.<br/> '''Example Configuration of LanguageID:'''<br/>Switch = '''0''' - German.<br/>Switch = '''1''' - English. | ||
+ | |- | ||
+ | | appSettings|| UBIK.Service.SessionManagementType || '''Configuration of the type [[USAM|session management]] the current service should use:'''<br/>Switch = '''0''' - Single Local Management.<br/>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.<br/>'''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 = | ||
+ | {| class="wikitable" | width = "88%" | ||
+ | |- | ||
+ | ! Area!! Setting!! Description | ||
+ | |- | ||
+ | | 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.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. | ||
+ | |- | ||
+ | | 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.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.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 = | = Examples = | ||
− | === Example | + | === Example CONTENT=== |
<source lang="xml"> | <source lang="xml"> | ||
− | + | <appSettings> | |
− | + | <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain,1433;Initial Catalog=UBIK.MYDATABASE;Persist Security Info=True;User ID=myuser;Password=mypassword"/> | |
− | + | <add key="UBIK.Service.ValidityPeriod" value="300"/> | |
− | + | <add key="UBIK.Service.LogLevel" value="10"/> | |
− | + | <add key="UBIK.Service.TokenRestrictive" value="1"/> | |
− | + | <add key="UBIK.Service.LanguageID" value="1"/> | |
− | + | <add key="UBIK.Service.SessionManagementType" value="1"/> | |
− | + | <add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP"/> | |
− | + | <add key="UBIK.Service.PushServiceUrl" value="https://myusamserver.mydomain:myport/UBIK/PUSH/UBIKPUSH.svc/SOAP"/> | |
− | + | </appSettings> | |
− | + | </source> | |
+ | |||
+ | === Example PUSH === | ||
+ | <source lang="xml"> | ||
+ | <appSettings> | ||
+ | <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain,1433;Initial Catalog=UBIK.MYDATABASE;Persist Security Info=True;User ID=myuser;Password=mypassword"/> | ||
+ | <add key="UBIK.Service.ValidityPeriod" value="300"/> | ||
+ | <add key="UBIK.Service.LogLevel" value="10"/> | ||
+ | <add key="UBIK.Service.TokenRestrictive" value="1"/> | ||
+ | <add key="UBIK.Service.LanguageID" value="1"/> | ||
+ | <add key="UBIK.Service.SessionManagementType" value="1"/> | ||
+ | <add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP"/> | ||
+ | </appSettings> | ||
+ | </source> | ||
+ | |||
+ | === Example USAM=== | ||
+ | <source lang="xml"> | ||
+ | <appSettings> | ||
+ | <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Persist Security Info=True;User ID=myuser;Password=mypassword"/> | ||
+ | <add key="UBIK.Service.HideAuthenticationInfo" value="1"/> | ||
+ | <add key="UBIK.Service.ValidityPeriod" value="0"/> | ||
+ | <add key="UBIK.Service.TokenValidityPeriod" value="60"/> | ||
+ | <add key="UBIK.Service.UserRestrictive" value="1"/> | ||
+ | <add key="UBIK.Service.DeviceRestrictive" value="0"/> | ||
</appSettings> | </appSettings> | ||
</source> | </source> | ||
− | === Example | + | === Example CONTENT Windows Azure === |
Configuration for a Microsoft Azure cloud database and a [[USAM#LAS|LAS]] service. | Configuration for a Microsoft Azure cloud database and a [[USAM#LAS|LAS]] service. | ||
Line 69: | Line 131: | ||
</source> | </source> | ||
− | === Example | + | === Example CONTENT Windows Authentication === |
Integrated security. | Integrated security. | ||
<source lang="xml"> | <source lang="xml"> |
Revision as of 07:45, 19 April 2024
The data and session management service of the web service are configured in this file.