Configuration Files/AppSettings.config - Revision history

NWE at 11:52, 7 May 2025

2025-05-07T11:52:30Z

NWE: /* Example CONTENT */

2025-05-07T07:50:04Z

‎Example CONTENT

NWE at 21:00, 5 May 2025

2025-05-05T21:00:43Z

NWE at 20:59, 5 May 2025

2025-05-05T20:59:22Z

NNE at 11:18, 24 April 2024

2024-04-24T11:18:21Z

NNE: /* Examples */

2024-04-22T06:14:47Z

‎Examples

NNE: /* PUSH Settings */

2024-04-22T06:12:04Z

‎PUSH Settings

NNE: /* CONTENT Settings */

2024-04-22T06:11:44Z

‎CONTENT Settings

NNE: /* Examples */

2024-04-22T05:41:32Z

‎Examples

NNE: /* USAM Settings */

2024-04-22T05:37:34Z

‎USAM Settings

@@ Line 115: / Line 115: @@
 </source>
-[[Category:Installing|Configuration Files/AppSettings.config]]
-[[Category:Web service|Configuration Files/AppSettings.config]]
 === Example PUSH ===
@@ Line 279: / Line 279: @@
 <headertabs />
 == See also ==
 * [[Configuration Files]]
 [[Category:Installing|Configuration Files/AppSettings.config]]
 [[Category:Web service|Configuration Files/AppSettings.config]]

@@ Line 87: / Line 87: @@
    <!-- 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"/>
+   <add key="UBIK.Service.ValidityPeriod" value="-1"/>
    <!-- Switch = "0" - No logging / Switch = "10" - Simple logging / Switch = "20" - Detailed logging  -->
@@ Line 109: / Line 109: @@
    <!-- 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>
+</appSettings><!-- Refreshing cached objects when a change (in the DB) by another process is detected -->
 </source>
+[[Category:Installing|Configuration Files/AppSettings.config]]
+[[Category:Web service|Configuration Files/AppSettings.config]]
 === Example PUSH ===

@@ Line 26: / Line 26: @@
 |-
 | 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 =
@@ Line 52: / Line 51: @@
 |-
 | 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.
 |-
 |}

@@ Line 52: / Line 52: @@
 |-
 | 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 =

@@ Line 11: / Line 11: @@
 | 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 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.
@@ Line 29: / Line 29: @@
 |}
-[[Category:Installing|Configuration Files/AppSettings.config]]
-[[Category:Web service|Configuration Files/AppSettings.config]]
 = PUSH Settings =
@@ Line 39: / Line 39: @@
 | 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 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.
@@ Line 55: / Line 55: @@
 |}
-[[Category:Installing|Configuration Files/AppSettings.config]]
-[[Category:Web service|Configuration Files/AppSettings.config]]
 = USAM Settings =
@@ Line 67: / Line 67: @@
 | 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 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 || 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.
@@ Line 79: / Line 79: @@
 |}
-[[Category:Installing|Configuration Files/AppSettings.config]]
-[[Category:Web service|Configuration Files/AppSettings.config]]
 = Examples =
@@ Line 90: / Line 90: @@
    <!-- 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 -->
+   <!-- 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"/>
@@ Line 126: / Line 126: @@
    <!-- 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 -->
+   <!-- 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"/>
@@ Line 163: / Line 163: @@
    <!-- 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 -->
+   <!-- 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"/>
@@ Line 192: / Line 192: @@
    <!-- 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 -->
+   <!-- 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" />
@@ Line 238: / Line 238: @@
    <!-- 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 -->
+   <!-- 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" />

@@ Line 108: / Line 108: @@
    <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"/>
-   <!-- 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"/>
 </appSettings>
@@ Line 144: / Line 144: @@
    <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"/>
 </appSettings>
@@ Line 159: / Line 159: @@
    <!-- 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"/>
@@ Line 171: / Line 171: @@
    <!-- 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"/>
    <!-- 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"/>
    </appSettings>
@@ Line 204: / Line 204: @@
    <!-- 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" />
    <!-- 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" />
@@ Line 222: / Line 222: @@
      <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" />
    </appSettings>
@@ Line 250: / Line 250: @@
    <!-- 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" />
    <!-- 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" />
@@ Line 265: / Line 265: @@
    <!-- 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"/>
@@ Line 272: / Line 272: @@
      <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="" />
    </appSettings>

@@ Line 49: / Line 49: @@
 | 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.

@@ Line 69: / Line 69: @@
 | 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.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/>