Jump to: navigation, search

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

(→‎CONTENT Settings)
 
(11 intermediate revisions by 2 users not shown)
Line 11: Line 11:
 
| appSettings|| UBIK.DataBase.ConnectionString || Configuration of the Microsoft SQL Server 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.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 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.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 enble 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.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.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.
Line 21: Line 21:
 
| 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|| 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|| 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.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.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.
 
| 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.EnableChangeNotifications || Whether or not to react to changes made by other processes, e.g., for updating the user group cache if necessary. 1 = change detection enabled, 0 = no change detection. {{Version/ServerSince|4.9.0}}
 
|-
 
|-
 
|}
 
|}
−
 
−
[[Category:Installing|Configuration Files/AppSettings.config]]
 
−
[[Category:Web service|Configuration Files/AppSettings.config]]
 
  
 
= PUSH Settings =
 
= PUSH Settings =
Line 39: Line 38:
 
| appSettings|| UBIK.DataBase.ConnectionString || Configuration of the Microsoft SQL Server 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.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 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.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 enble 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.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.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 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|| 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.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|| 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.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.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]]
 
  
 
= USAM Settings =
 
= USAM Settings =
Line 67: Line 63:
 
| 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.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 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.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 || Duration [in seconds] 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.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.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/>
Line 90: Line 86:
  
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
−
   <!-- Switch = "-1" - cached objects are valid indefinetly / Switch = "0" - cache is always invalid and will get constantly updated / Switch = "+1" - cached objects are checked every 1+ seconds -->
+
   <!-- 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"/>
 
   <add key="UBIK.Service.ValidityPeriod" value="300"/>
  
Line 98: Line 94:
  
 
   <!-- Validation of the used Token -->
 
   <!-- Validation of the used Token -->
−
   <!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successfull authentication -->
+
   <!-- 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"/>
  
Line 108: Line 104:
 
   <add key="UBIK.Service.SessionManagementType" value="1"/>
 
   <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. -->
+
   <!-- 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"/>
 
   <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. -->
+
   <!-- 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"/>
 
   <add key="UBIK.Service.PushServiceUrl" value="https://myusamserver.mydomain:myport/UBIK/PUSH/UBIKPUSH.svc/SOAP"/>
 
</appSettings>
 
</appSettings>
 
</source>
 
</source>
  
−
[[Category:Installing|Configuration Files/AppSettings.config]]
+
 
−
[[Category:Web service|Configuration Files/AppSettings.config]]
+
 
  
 
=== Example PUSH ===
 
=== Example PUSH ===
Line 126: Line 122:
  
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
−
   <!-- Switch = "-1" - cached objects are valid indefinetly / Switch = "0" - cache is always invalid and will get constantly updated / Switch = "+1" - cached objects are checked every 1+ seconds -->
+
   <!-- 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"/>
 
   <add key="UBIK.Service.ValidityPeriod" value="300"/>
  
 
   <!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging  -->
 
   <!-- 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. -->
+
   <!-- 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"/>
  
 
   <!-- Validation of the used Token -->
 
   <!-- Validation of the used Token -->
−
   <!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successfull authentication -->
+
   <!-- 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"/>
  
Line 144: Line 140:
 
   <add key="UBIK.Service.SessionManagementType" value="1"/>
 
   <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. -->
+
   <!-- 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"/>
 
   <add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP"/>
 
</appSettings>
 
</appSettings>
 
</source>
 
</source>
  
−
[[Category:Installing|Configuration Files/AppSettings.config]]
+
 
−
[[Category:Web service|Configuration Files/AppSettings.config]]
+
 
  
 
=== Example USAM===
 
=== Example USAM===
Line 159: Line 155:
  
 
   <!-- Authentication information error status -->
 
   <!-- Authentication information error status -->
−
   <!-- Switch = 0 - deliver error status if authentication fails / Switch = 1 - hide error status if authentication fails -->
+
   <!-- Switch = "0" - deliver error status if authentication fails / Switch = "1" - hide error status if authentication fails -->
 
   <add key="UBIK.Service.HideAuthenticationInfo" value="1"/>
 
   <add key="UBIK.Service.HideAuthenticationInfo" value="1"/>
  
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
−
   <!-- Switch = "-1" - cached objects are valid indefinetly / Switch = "0" - cache is always invalid and will get constantly updated / Switch = "+1" - cached objects are checked every 1+ seconds -->
+
   <!-- 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"/>
 
   <add key="UBIK.Service.ValidityPeriod" value="0"/>
  
−
   <!-- Duration [in seconds] how long a token is valid. -->
+
   <!-- 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) -->
+
   <!-- 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"/>
 
   <add key="UBIK.Service.TokenValidityPeriod" value="60"/>
  
 
   <!-- Authorization mechanism for user logins -->
 
   <!-- Authorization mechanism for user logins -->
−
   <!-- Switch = 0 - every login may connect / Switch = 1 - only known logins may connect to UBIK® -->
+
   <!-- 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 -->
 
   <!-- Authorization mechanism for device logins -->
−
   <!-- Switch = 0 - every device may connect / Switch = 1- only known and active devices may connect to UBIK® -->
+
   <!-- Switch = "0" - every device may connect / Switch = "1" - only known and active devices may connect to UBIK® -->
 
   <add key="UBIK.Service.DeviceRestrictive" value="0"/>
 
   <add key="UBIK.Service.DeviceRestrictive" value="0"/>
 
   </appSettings>
 
   </appSettings>
 
</source>
 
</source>
  
−
[[Category:Installing|Configuration Files/AppSettings.config]]
+
 
−
[[Category:Web service|Configuration Files/AppSettings.config]]
+
 
  
 
=== Example CONTENT Windows Azure ===  
 
=== Example CONTENT Windows Azure ===  
Line 192: Line 188:
  
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
−
   <!-- Switch = "-1" - cached objects are valid indefinetly / Switch = "0" - cache is always invalid and will get constantly updated / Switch = "+1" - cached objects are checked every 1+ seconds -->
+
   <!-- 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" />
 
     <add key="UBIK.Service.ValidityPeriod" value="0" />
  
 
   <!-- Duration [in seconds] how long a token is valid. -->
 
   <!-- Duration [in seconds] 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) -->
+
   <!-- 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" />
 
     <add key="UBIK.Service.TokenValidityPeriod" value="300" />
  
Line 204: Line 200:
  
 
   <!-- Authorization mechanism for user logins -->
 
   <!-- Authorization mechanism for user logins -->
−
   <!-- Switch = 0 - every login may connect / Switch = 1 - only known logins may connect to UBIK® -->
+
   <!-- 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 -->
 
   <!-- Authorization mechanism for device logins -->
−
   <!-- Switch = 0 - every device may connect / Switch = 1- only known and active devices may connect to UBIK® -->
+
   <!-- 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 -->
 
   <!-- Validation of the used Token -->
−
   <!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successfull authentication -->
+
   <!-- 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" />
  
Line 222: Line 218:
 
     <add key="UBIK.Service.SessionManagementType" value="1" />
 
     <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. -->
+
   <!-- 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" />
 
     <add key="UBIK.Service.SessionManagementUrl" value="https://myusamserver.mydomain:myport/UBIK/USAM/USAM.svc/SOAP" />
 
   </appSettings>
 
   </appSettings>
 
</source>
 
</source>
  
−
[[Category:Installing|Configuration Files/AppSettings.config]]
+
 
−
[[Category:Web service|Configuration Files/AppSettings.config]]
+
 
  
 
=== Example CONTENT Windows Authentication ===
 
=== Example CONTENT Windows Authentication ===
Line 238: Line 234:
  
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
 
   <!-- The duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel. -->
−
   <!-- Switch = "-1" - cached objects are valid indefinetly / Switch = "0" - cache is always invalid and will get constantly updated / Switch = "+1" - cached objects are checked every 1+ seconds -->
+
   <!-- 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" />
 
     <add key="UBIK.Service.ValidityPeriod" value="0" />
  
 
   <!-- Duration [in seconds] how long a token is valid. -->
 
   <!-- Duration [in seconds] 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) -->
+
   <!-- 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" />
 
     <add key="UBIK.Service.TokenValidityPeriod" value="300" />
  
 
   <!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging  -->
 
   <!-- 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. -->
+
   <!-- 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 -->
 
   <!-- Authorization mechanism for user logins -->
−
   <!-- Switch = 0 - every login may connect / Switch = 1 - only known logins may connect to UBIK® -->
+
   <!-- 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 -->
 
   <!-- Authorization mechanism for device logins -->
−
   <!-- Switch = 0 - every device may connect / Switch = 1- only known and active devices may connect to UBIK® -->
+
   <!-- 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 -->
 
   <!-- Validation of the used Token -->
−
   <!-- Switch = "0" - the token is not validated / Switch = "1" - data access is only possible after a successfull authentication -->
+
   <!-- 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" />
  
Line 265: Line 261:
  
 
   <!-- Authentication information error status -->
 
   <!-- Authentication information error status -->
−
   <!-- Switch = 0 - deliver error status if authentication fails / Switch = 1 - hide error status if authentication fails -->
+
   <!-- Switch ="0" - deliver error status if authentication fails / Switch = "1" - hide error status if authentication fails -->
 
     <add key="UBIK.Service.HideAuthenticationInfo" value"1"/>
 
     <add key="UBIK.Service.HideAuthenticationInfo" value"1"/>
  
Line 272: Line 268:
 
     <add key="UBIK.Service.SessionManagementType" value="0" />
 
     <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. -->
+
   <!-- In the case of SessionManagementType = "1", the URL of the PUSH Service must be configured using this setting. -->
 
     <add key="UBIK.Service.SessionManagementUrl" value="" />
 
     <add key="UBIK.Service.SessionManagementUrl" value="" />
 
   </appSettings>
 
   </appSettings>
Line 281: Line 277:
 
<headertabs />
 
<headertabs />
  
−
[[Category:Installing|Configuration Files/AppSettings.config]]
+
 
−
[[Category:Web service|Configuration Files/AppSettings.config]]
+
 
  
 
== See also ==
 
== See also ==

Latest revision as of 21:00, 5 May 2025

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.
appSettings UBIK.Service.EnableChangeNotifications Whether or not to react to changes made by other processes, e.g., for updating the user group cache if necessary. 1 = change detection enabled, 0 = no change detection.



See also

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