Difference between revisions of "Configuration Files/AppSettings.config"
(→PUSH Settings) |
|||
(One intermediate revision by the same user 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 | + | | 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.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: | ||
|} | |} | ||
− | + | ||
− | + | ||
= PUSH Settings = | = PUSH Settings = | ||
Line 39: | Line 39: | ||
| 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 | + | | 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.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: | ||
|} | |} | ||
− | + | ||
− | + | ||
= USAM Settings = | = 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.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 | + | | 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.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: | ||
|} | |} | ||
− | + | ||
− | + | ||
= Examples = | = Examples = | ||
Line 90: | Line 90: | ||
<!-- 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 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"/> | <add key="UBIK.Service.ValidityPeriod" value="300"/> | ||
Line 108: | Line 108: | ||
<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> | ||
Line 126: | Line 126: | ||
<!-- 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 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"/> | <add key="UBIK.Service.ValidityPeriod" value="300"/> | ||
Line 144: | Line 144: | ||
<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> | ||
Line 159: | Line 159: | ||
<!-- 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 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"/> | <add key="UBIK.Service.ValidityPeriod" value="0"/> | ||
Line 171: | Line 171: | ||
<!-- 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> | ||
Line 192: | Line 192: | ||
<!-- 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 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" /> | <add key="UBIK.Service.ValidityPeriod" value="0" /> | ||
Line 204: | Line 204: | ||
<!-- 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" /> | ||
Line 222: | Line 222: | ||
<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> | ||
Line 238: | Line 238: | ||
<!-- 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 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" /> | <add key="UBIK.Service.ValidityPeriod" value="0" /> | ||
Line 250: | Line 250: | ||
<!-- 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" /> | ||
Line 265: | Line 265: | ||
<!-- 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 272: | ||
<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> |
Latest revision as of 11:18, 24 April 2024
The data and session management service of the web service are configured in this file.