{{Attention|SessionManagementType has to be of ''Local Application Service'' always! {{Version/ServerSince|2.4.3}}}}
= CONTENT 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.ValidityPeriod || Duration [in seconds] how long records are valid before they will be required for changes by the kernel; '''-1''' to turn offDuration [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.LogLevel ||The To activate the Service logging, the LogLevel setting should be changed accordingly switched to '''Verbose''' in the [[Logging#How_To_Configure_Logging]].configand 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, switch . <br/>Switch = '''10''', - Simple logging, switch .<br/>Switch = '''20''', - Detailed logging.
|-
| appSettings|| UBIK.Service.LanguageID TokenRestrictive ||ID Validation of the language that must be used by Token <br/>'''Configuration of TokenRestrictive:'''<br/>Switch = '''0''' - the Web Servicetoken is not validated. The Service will deliver the content of MultiLanguage Properties in this language<br/>Switch = '''1''' - data access is only possible after a successfull authentication.
|-
| appSettings|| UBIK.Service.UserRestrictive LanguageID ||If ID of the language that must be used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this switch is language.<br/> '''1Example Configuration of LanguageID:''', only known logins may connect to {{UBIK}}.<br/>If it is set to Switch = '''0''', every login may connect- German.<br/>Switch = '''1''' - English.
|-
| appSettings|| UBIK.Service.DeviceRestrictive SessionManagementType ||If this switch is '''1Configuration of the type [[USAM|session management]] the current service should use:''', only known and active devices may connect to {{UBIK}}.<br/>If it is set to Switch = '''0''', every device may connect- Single Local Management.<br/>Switch = '''1''' - USAM Service
|-
| appSettings|| UBIK.Service.TokenRestrictive SessionManagementUrl||If this switch In the case of SessionManagementType Switch is set to '''1''', data access is only possible after a successfull authenticationthe URL of the USAM Service must be configured using this setting.<br/>'''If it a port other than 443 (default port for https) is set used, it has to be specified here as well.'''0''', the token is not validated.
|-
| appSettings|| UBIK.Service.GroupRightsUpdateIntervall PushServiceUrl||In the case of SessionManagementType Switch is set to ''' GroupRightsUpdateIntervall setting is optional1'''. Update Interval [in seconds] for , the Group Rights Evaluator. If URL of the PUSH Service can be configured using this setting is not configured, the ValidityPeriod .'''If a port other than 443 (default port for https) is used for defining the interval for the Rights Evaluator, it has to be specified here as well.'''
|-
| appSettings|| UBIK.Service.SessionManagementType GroupRightsUpdateIntervall ||Configure the type of [[USAM|session management]] the current service should use:<br/>'''0GroupRightsUpdateIntervall setting is optional''' = Single Local Management / '''1''' = Local Application Service / '''2''' = Global Application Service. 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.SessionManagementUrl} = PUSH Settings ={|class="wikitable" |In the case of SessionManagementType width = '''1''' or '''2''', configure the URL of the application service via this setting.<br/>If a port other than 443 (default port for https) is used, it has to be specified here as well."88%"
|-
! Area!! Setting!! Description|-| appSettings|| UBIK.DataBase.ConnectionString || Configuration of the SQL connect string to the {{UBIK}} Database|-| appSettings|| UBIK.Service.HideAuthenticationInfoValidityPeriod || 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 switch 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, if it is set to .<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 =
=== Example 1 CONTENT===
<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="0300" /> <add key="UBIK.Service.TokenValidityPeriodLogLevel" value="30010" /> <add key="UBIK.Service.LogLevelTokenRestrictive" value="101" /> <add key="UBIK.Service.UserRestrictiveLanguageID" value="1" /> <add key="UBIK.Service.DeviceRestrictiveSessionManagementType" 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="01" /> <add key="UBIK.Service.SessionManagementType" value="01" /> <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>
</source>
=== Example 2 (CONTENT Windows Azure) ===
Configuration for a Microsoft Azure cloud database and a [[USAM#LAS|LAS]] service.
</source>
=== Example 3 (CONTENT Windows Authentication) ===
Integrated security.
<source lang="xml">