| appSettings|| UBIK.DataBase.ConnectionString || Configuration of the Microsoft SQL Server connect string to the {{UBIK}} Database.
|-
| appSettings|| UBIK.Service.ValidityPeriod || Duration The 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 valid indefinetly. <br/> Switch = '''0''' - cache is always invalid and will get constantly updated. <br/> Switch = '''+1''' - cached objects are checked every 1+ seconds.
|-
| appSettings|| UBIK.Service.LogLevel || To enble enable logging the LogLevel must be set 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.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.LanguageID || ID Configuration of the language LanguageID that must be 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 [[USAM|session management]] the current service should will use:'''<br/>Switch = '''0''' - Single Local Management.<br/>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.<br/>'''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.
|-
|}
[[Category:Installing|Configuration Files/AppSettings.config]]
[[Category:Web service|Configuration Files/AppSettings.config]]
= PUSH Settings =
| appSettings|| UBIK.DataBase.ConnectionString || Configuration of the Microsoft SQL Server connect string to the {{UBIK}} Database.
|-
| appSettings|| UBIK.Service.ValidityPeriod || Duration The 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 valid indefinetly. <br/> Switch = '''0''' - cache is always invalid and will get constantly updated. <br/> Switch = '''+1''' - cached objects are checked every 1+ seconds.
|-
| appSettings|| UBIK.Service.LogLevel || To enble enable logging the LogLevel must be set 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.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.LanguageID || ID Configuration of the language LanguageID that must be 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 [[USAM|session management]] the current service should will use:'''<br/>Switch = '''0''' - Single Local Management.<br/>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.<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.
| 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 The 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 valid indefinetly. <br/> Switch = '''0''' - cache is always invalid and will get constantly updated. <br/> Switch = '''+1''' - cached objects are checked every 1+ seconds.
|-
| appSettings|| UBIK.Service.TokenValidityPeriod || Duration The duration [in seconds] of how long a token is valid. For security reasons, it is recommended that the token validity should be set for short periode with a maximum of 86400 seconds (24 hours).<br/> '''Example Configuration of TokenValidityPeriod:'''<br/> Switch = '''60''' - token is valid for only 60 seconds. <br/> Switch = '''3600''' - token is valid for 1 hour.
|-
| appSettings|| UBIK.Service.UserRestrictive || Authorization mechanism for user login<br/>'''Configuraion of UserRestrictive:'''<br/>Switch = '''0''' - every login may connect.<br/>Switch = '''1''' - only known logins may connect to {{UBIK}}.<br/>
|}
[[Category:Installing|Configuration Files/AppSettings.config]][[Category:Web service|Configuration Files/AppSettings.config]]
= Examples =
<source lang="xml">
<appSettings>
<!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
<add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain,1433;Initial Catalog=UBIK.MYDATABASE;Persist Security Info=True;User ID=myuser;Password=mypassword"/>
<!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
<!-- 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 -->
<add key="UBIK.Service.ValidityPeriod" value="300"/>
<!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging -->
<!-- To enble logging the LogLevel must be set to Verbose in the Logging.config. -->
<add key="UBIK.Service.LogLevel" value="10"/>
<!-- Validation of the used Token -->
<!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successful authentication -->
<add key="UBIK.Service.TokenRestrictive" value="1"/>
<!-- Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language. -->
<add key="UBIK.Service.LanguageID" value="1"/>
<!-- Configuration of the type session management the current service will use -->
<!-- Switch = "0" - Single Local Management / Switch = "1" - USAM Service -->
<add key="UBIK.Service.SessionManagementType" value="1"/>
<!-- In the case of SessionManagementType = "1", the URL of the USAM Service must be configured using this setting. -->
<add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP"/>
<!-- In the case of SessionManagementType = "1", the URL of the PUSH Service must be configured using this setting. -->
<add key="UBIK.Service.PushServiceUrl" value="https://myusamserver.mydomain:myport/UBIK/PUSH/UBIKPUSH.svc/SOAP"/>
</appSettings>
</source>
=== Example PUSH ===
<source lang="xml">
<appSettings>
<!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
<add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain,1433;Initial Catalog=UBIK.MYDATABASE;Persist Security Info=True;User ID=myuser;Password=mypassword"/>
<!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
<!-- 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 -->
<add key="UBIK.Service.ValidityPeriod" value="300"/>
<!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging -->
<!-- To enable logging the LogLevel must be set to Verbose in the Logging.config. -->
<add key="UBIK.Service.LogLevel" value="10"/>
<!-- Validation of the used Token -->
<!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successful authentication -->
<add key="UBIK.Service.TokenRestrictive" value="1"/>
<!-- Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language. -->
<add key="UBIK.Service.LanguageID" value="1"/>
<!-- Configuration of the type session management the current service will use -->
<!-- Switch = "0" - Single Local Management / Switch = "1" - USAM Service -->
<add key="UBIK.Service.SessionManagementType" value="1"/>
<!-- In the case of SessionManagementType = "1", the URL of the USAM Service must be configured using this setting. -->
<add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP"/>
</appSettings>
</source>
=== Example USAM===
<source lang="xml">
<appSettings>
<!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
<add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Persist Security Info=True;User ID=myuser;Password=mypassword"/>
<!-- Authentication information error status -->
<!-- Switch = "0" - deliver error status if authentication fails / Switch = "1" - hide error status if authentication fails -->
<add key="UBIK.Service.HideAuthenticationInfo" value="1"/>
<!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
<!-- 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 -->
<add key="UBIK.Service.ValidityPeriod" value="0"/>
<!-- The duration [in seconds] of how long a token is valid. -->
<!-- For security reasons, it is recommended that the token validity should be set for a short period with a maximum of 86400 seconds (24 hours) -->
<add key="UBIK.Service.TokenValidityPeriod" value="60"/>
<!-- Authorization mechanism for user logins -->
<!-- Switch = "0" - every login may connect / Switch = "1" - only known logins may connect to UBIK® -->
<add key="UBIK.Service.UserRestrictive" value="1"/>
<!-- Authorization mechanism for device logins -->
<!-- Switch = "0" - every device may connect / Switch = "1" - only known and active devices may connect to UBIK® -->
<add key="UBIK.Service.DeviceRestrictive" value="0"/>
</appSettings>
</source>
=== Example CONTENT Windows Azure ===
<source lang="xml">
<appSettings>
<!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
<add key="UBIK.DataBase.ConnectionString" value="Data Source=tcp:xxxxxxxx.database.windows.net,1433;Initial Catalog=UBIK.MYDATABASE;User ID=myclouduser@xxxxxxxx;Password=mypassword" />
<!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
<!-- 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 -->
<add key="UBIK.Service.ValidityPeriod" value="0" />
<!-- Duration [in seconds] how long a token is valid. -->
<!-- For security reasons, it is recommended that the token validity should be set for a short period with a maximum of 86400 seconds (24 hours) -->
<add key="UBIK.Service.TokenValidityPeriod" value="300" />
<!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging -->
<!-- To enble logging the LogLevel must be set to Verbose in the Logging.config. -->
<add key="UBIK.Service.LogLevel" value="10" />
<!-- Authorization mechanism for user logins -->
<!-- Switch ="0" - every login may connect / Switch = "1" - only known logins may connect to UBIK® -->
<add key="UBIK.Service.UserRestrictive" value="1" />
<!-- Authorization mechanism for device logins -->
<!-- Switch = "0" - every device may connect / Switch = "1" - only known and active devices may connect to UBIK® -->
<add key="UBIK.Service.DeviceRestrictive" value="1" />
<!-- Validation of the used Token -->
<!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successful authentication -->
<add key="UBIK.Service.TokenRestrictive" value="1" />
<!-- Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language. -->
<add key="UBIK.Service.LanguageID" value="0" />
<!-- Configuration of the type session management the current service will use -->
<!-- Switch = "0" - Single Local Management / Switch = "1" - USAM Service -->
<add key="UBIK.Service.SessionManagementType" value="1" />
<!-- In the case of SessionManagementType = "1", the URL of the USAM Service must be configured using this setting. -->
<add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP" />
</appSettings>
</source>
=== Example CONTENT Windows Authentication ===
<source lang="xml">
<appSettings>
<!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
<add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Integrated Security=SSPI;" />
<!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
<!-- 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 -->
<add key="UBIK.Service.ValidityPeriod" value="0" />
<!-- Duration [in seconds] how long a token is valid. -->
<!-- For security reasons, it is recommended that the token validity should be set for a short period with a maximum of 86400 seconds (24 hours) -->
<add key="UBIK.Service.TokenValidityPeriod" value="300" />
<!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging -->
<!-- To enable logging the LogLevel must be set to Verbose in the Logging.config. -->
<add key="UBIK.Service.LogLevel" value="10" />
<!-- Authorization mechanism for user logins -->
<!-- Switch = "0" - every login may connect / Switch = "1" - only known logins may connect to UBIK® -->
<add key="UBIK.Service.UserRestrictive" value="1" />
<!-- Authorization mechanism for device logins -->
<!-- Switch = "0" - every device may connect / Switch = "1"- only known and active devices may connect to UBIK® -->
<add key="UBIK.Service.DeviceRestrictive" value="1" />
<!-- Validation of the used Token -->
<!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successful authentication -->
<add key="UBIK.Service.TokenRestrictive" value="1" />
<!-- Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language. -->
<add key="UBIK.Service.LanguageID" value="0" />
<!-- Authentication information error status -->
<!-- Switch ="0" - deliver error status if authentication fails / Switch = "1" - hide error status if authentication fails -->
<add key="UBIK.Service.HideAuthenticationInfo" value"1"/>
<!-- Configuration of the type session management the current service will use -->
<!-- Switch = "0" - Single Local Management / Switch = "1" - USAM Service -->
<add key="UBIK.Service.SessionManagementType" value="0" />
<!-- In the case of SessionManagementType = "1", the URL of the PUSH Service must be configured using this setting. -->
<add key="UBIK.Service.SessionManagementUrl" value="" />
</appSettings>