Jump to: navigation, search

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

 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
The data and session management service of the web service are configured in this file.
 
The data and session management service of the web service are configured in this file.
  
−
= Settings =
+
{{Attention|SessionManagementType has to be of ''Local Application Service'' always! {{Version/ServerSince|2.4.3}}}}
 +
 
 +
= CONTENT Settings =
  
 
{| class="wikitable" | width = "88%"
 
{| class="wikitable" | width = "88%"
Line 7: 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 Microsoft SQL Server connect string to the {{UBIK}} Database.
 
|-
 
|-
−
| appSettings|| UBIK.Service.MaxIdleMinutes ||Duration [in minutes] until a unused WebService shuts down automatically
+
| appSettings|| UBIK.Service.ValidityPeriod || 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 indefinitely. <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.ValityPeriode ||Duration [in seconds] until a cached record is marked as outdated in the UBIK Kernel
+
| appSettings|| UBIK.Service.LogLevel || To 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|| LogLevel ||LogLevel
+
| 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|| 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.
+
| 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|| UserRestrictive ||If this switch is '''1''', only known logins may connect to {{UBIK}}.<br/>If it is set to '''0''', every login may connect.
+
| appSettings|| UBIK.Service.SessionManagementType || '''Configuration of the type [[USAM|session management]] the current service will use:'''<br/>Switch = '''0''' - Single Local Management.<br/>Switch = '''1''' - USAM Service.
 
|-
 
|-
−
| appSettings|| DeviceRestrictive ||If this switch is '''1''', only known and active devices may connect to UBIK.<br/>If it is set to '''0''', every device may connect.
+
| 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|| TokenRestrictive ||If this switch is '''1''', data access is only possible after a successfull authentication.<br/>If it is set to '''0''', the token is not validated.
+
| 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|| SessionManagementType ||Configure the type of [[USAM|session management]] the current service should use:<br/>'''0''' = Single Local Management / '''1''' = Local Application Service / '''2''' = Global Application 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.
 
|-
 
|-
−
| appSettings|| SessionManagementUrl||In the case of SessionManagementType = '''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.
+
|}
 +
 
 +
 
 +
 
 +
 
 +
= PUSH Settings =
 +
{| class="wikitable" | width = "88%"
 +
|-
 +
! 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. <br/> '''Configuration of ValidityPeriod:'''<br/> Switch = '''-1''' - cached objects are valid indefinitely. <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 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 || Configuration of the LanguageID that is used by the Web Service. The Service will deliver the content of MultiLanguage Properties in this language.
 
|-
 
|-
−
| appSettings|| EnableViewCache || Enable = '''1''' / Disable = '''0''' the [[View Cache]] feature
+
| appSettings|| UBIK.Service.SessionManagementType || '''Configuration of the type [[USAM|session management]] the current service will use:'''<br/>Switch = '''0''' - Single Local Management.<br/>Switch = '''1''' - USAM Service.
 
|-
 
|-
−
| loggingConfiguration|| listeners ||Full configuration of the {{UBIK}} Logging
+
| 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.'''
 
|-
 
|-
−
| requestLimits || maxAllowedContentLength || Configure the maximum allowed length of received content (see [[Web_Service_Configuration_Example#system.webServer|Example]])
+
| 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 Microsoft SQL Server connect string to the {{UBIK}} Database.
 +
|-
 +
| 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 || 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 indefinitely. <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 || 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/>
 +
|-
 +
| 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.
 +
|-
 +
|}
 +
 +
 +
  
 
= Examples =
 
= Examples =
−
=== Example 1 ===
+
=== Example CONTENT===
 +
<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 ===  
 +
Configuration for a Microsoft Azure cloud database and a [[USAM#LAS|LAS]] service.
 +
 
 
<source lang="xml">
 
<source lang="xml">
 
   <appSettings>
 
   <appSettings>
−
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;User ID=myuser;Password=mypassword" />
+
  <!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
−
    <add key="UBIK.Service.MaxIdleMinutes" value="5" />
+
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=tcp:xxxxxxxx.database.windows.net,1433;Initial Catalog=UBIK.MYDATABASE;User ID=myclouduser@xxxxxxxx;Password=mypassword" />
−
     <add key="UBIK.Service.ValityPeriode" value="0" />
+
 
−
     <add key="UBIK.Service.TokenValityPeriode" value="300" />
+
  <!-- 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" />
 
     <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" />
 
     <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" />
 
     <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" />
 
     <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" />
 
     <add key="UBIK.Service.LanguageID" value="0" />
−
     <add key="UBIK.Service.SessionManagementType" value="0" />
+
 
−
     <add key="UBIK.Service.SessionManagementUrl" value="" />
+
  <!-- 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>
 
   </appSettings>
 
</source>
 
</source>
  
−
=== Example 2 (Windows Azure) ===
 
−
Configuration for a Microsoft Azure cloud database and a [[USAM#LAS|LAS]] service.
 
  
 +
 +
 +
=== Example CONTENT Windows Authentication ===
 +
Integrated security.
 
<source lang="xml">
 
<source lang="xml">
 
   <appSettings>
 
   <appSettings>
−
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=tcp:xxxxxxxx.database.windows.net,1433;Initial Catalog=UBIK.MYDATABASE;User ID=myclouduser@xxxxxxxx;Password=mypassword" />
+
  <!-- Configuration of the Microsoft SQL Server connect string to the UBIK® Database -->
−
    <add key="UBIK.Service.MaxIdleMinutes" value="5" />
+
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Integrated Security=SSPI;" />
−
     <add key="UBIK.Service.ValityPeriode" value="0" />
+
 
−
     <add key="UBIK.Service.TokenValityPeriode" value="300" />
+
  <!-- 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" />
 
     <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" />
 
     <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" />
 
     <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" />
 
     <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" />
 
     <add key="UBIK.Service.LanguageID" value="0" />
−
     <add key="UBIK.Service.SessionManagementType" value="1" />
+
 
−
     <add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP" />
+
  <!-- 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>
 
   </appSettings>
 
</source>
 
</source>
Line 76: Line 281:
 
<headertabs />
 
<headertabs />
  
−
[[Category:Installing]]
+
 
−
[[Category:Web service]]
+
 
 +
 
 +
== See also ==
 +
* [[Configuration Files]]
 +
 
 +
[[Category:Installing|Configuration Files/AppSettings.config]]
 +
[[Category:Web service|Configuration Files/AppSettings.config]]

Latest revision as of 11:18, 24 April 2024

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

IC Attention.pngSessionManagementType has to be of Local Application Service always!
[edit]

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.



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.



USAM Settings

Area Setting Description
appSettings UBIK.DataBase.ConnectionString Configuration of the Microsoft SQL Server 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 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.TokenValidityPeriod 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).
Example Configuration of TokenValidityPeriod:
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 login
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

<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>



Example PUSH

<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>



Example USAM

<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>



Example CONTENT Windows Azure

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

  <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>



Example CONTENT Windows Authentication

Integrated security.

  <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>
IC Hint square.pngThe port number myport must be specified only if other than 443.



See also

Retrieved from "https://wiki.augmensys.com/index.php?title=Configuration_Files/AppSettings.config&oldid=26330"