Jump to: navigation, search

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

Line 11: Line 11:
 
| appSettings|| UBIK.DataBase.ConnectionString ||Configuration of the SQL connect string to the {{UBIK}} Database
 
| appSettings|| UBIK.DataBase.ConnectionString ||Configuration of the SQL connect string to the {{UBIK}} Database
 
|-
 
|-
−
| appSettings|| UBIK.Service.MaxIdleMinutes || Duration [in minutes] an unused WebService shuts down automatically
+
| appSettings|| UBIK.Service.ValityPeriode || Duration [in seconds] how long records are valid before they will be required for changes by the kernel; '''-1''' to turn off
−
|-
+
−
| appSettings|| UBIK.Service.ValityPeriode || Duration [in seconds] how long records are valid before they will be requeried for changes by the kernel; '''-1''' to turn off
+
−
 
+
 
Duration [in seconds] until a cached record is marked as outdated in the {{UBIK}} Kernel  
 
Duration [in seconds] until a cached record is marked as outdated in the {{UBIK}} Kernel  
 
|-
 
|-
−
| appSettings|| LogLevel ||LogLevel
+
| appSettings|| LogLevel ||The LogLevel should be changed accordingly in the [[Logging#How_To_Configure_Logging]].config. LogLevel switch '''0''', No logging, switch '''10''', Simple logging, switch '''20''', Detailed logging.
 
|-
 
|-
 
| 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|| 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.
Line 27: Line 24:
 
| 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|| 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|| UseLocalCustomizing ||Used for local debugging only. If this switch is true, the system uses a locally staged customizing if available. Otherwise, it will load the released one.
+
| appSettings|| GroupRightsUpdateIntervall ||''' GroupRightsUpdateIntervall setting is optional'''. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValityPeriode is used for defining the interval for the Rights Evaluator.
−
|-
+
−
| appSettings|| GroupRightsUpdateIntervall ||Update Intervall [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValityPeriode is used for defining the intervall for the Rights Evaluator.
+
 
|-
 
|-
 
| 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|| 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
Line 35: Line 30:
 
| 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.
 
| 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.
 
|-
 
|-
−
| loggingConfiguration|| listeners ||Full configuration of the {{UBIK}} Logging
+
| appSettings|| HideAuthenticationInfo|| If this switch is '''0''', deliver error status if authentication fails, if it is set to '''1''', hide error status if authentication fails.
−
|-
+
−
| requestLimits || maxAllowedContentLength || Configure the maximum allowed length of received content (see [[Web_Service_Configuration_Example#system.webServer|Example]])
+
 
|-
 
|-
 
|}
 
|}
Line 46: Line 39:
 
   <appSettings>
 
   <appSettings>
 
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;User ID=myuser;Password=mypassword" />
 
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;User ID=myuser;Password=mypassword" />
−
     <add key="UBIK.Service.MaxIdleMinutes" value="5" />
+
     <add key="UBIK.Service.ValityPeriod" value="0" />
−
    <add key="UBIK.Service.ValityPeriode" value="0" />
+
     <add key="UBIK.Service.TokenValityPeriod" value="300" />
−
     <add key="UBIK.Service.TokenValityPeriode" value="300" />
+
 
     <add key="UBIK.Service.LogLevel" value="10" />
 
     <add key="UBIK.Service.LogLevel" value="10" />
 
     <add key="UBIK.Service.UserRestrictive" value="1" />
 
     <add key="UBIK.Service.UserRestrictive" value="1" />
Line 65: Line 57:
 
   <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" />
 
     <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.MaxIdleMinutes" value="5" />
+
     <add key="UBIK.Service.ValityPeriod" value="0" />
−
    <add key="UBIK.Service.ValityPeriode" value="0" />
+
     <add key="UBIK.Service.TokenValityPeriod" value="300" />
−
     <add key="UBIK.Service.TokenValityPeriode" value="300" />
+
 
     <add key="UBIK.Service.LogLevel" value="10" />
 
     <add key="UBIK.Service.LogLevel" value="10" />
 
     <add key="UBIK.Service.UserRestrictive" value="1" />
 
     <add key="UBIK.Service.UserRestrictive" value="1" />
Line 83: Line 74:
 
   <appSettings>
 
   <appSettings>
 
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Integrated Security=SSPI;" />
 
     <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Integrated Security=SSPI;" />
−
     <add key="UBIK.Service.MaxIdleMinutes" value="5" />
+
     <add key="UBIK.Service.ValityPeriod" value="0" />
−
    <add key="UBIK.Service.ValityPeriode" value="0" />
+
     <add key="UBIK.Service.TokenValityPeriod" value="300" />
−
     <add key="UBIK.Service.TokenValityPeriode" value="300" />
+
 
     <add key="UBIK.Service.LogLevel" value="10" />
 
     <add key="UBIK.Service.LogLevel" value="10" />
 
     <add key="UBIK.Service.UserRestrictive" value="1" />
 
     <add key="UBIK.Service.UserRestrictive" value="1" />
Line 91: Line 81:
 
     <add key="UBIK.Service.TokenRestrictive" value="1" />
 
     <add key="UBIK.Service.TokenRestrictive" value="1" />
 
     <add key="UBIK.Service.LanguageID" value="0" />
 
     <add key="UBIK.Service.LanguageID" value="0" />
 +
    <add key="UBIK.Service.HideAuthenticationInfo" value"1"/>
 
     <add key="UBIK.Service.SessionManagementType" value="0" />
 
     <add key="UBIK.Service.SessionManagementType" value="0" />
 
     <add key="UBIK.Service.SessionManagementUrl" value="" />
 
     <add key="UBIK.Service.SessionManagementUrl" value="" />

Revision as of 10:32, 7 July 2023

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]

Settings

Area Setting Description
appSettings UBIK.DataBase.ConnectionString Configuration of the SQL connect string to the UBIK® Database
appSettings UBIK.Service.ValityPeriode Duration [in seconds] how long records are valid before they will be required for changes by the kernel; -1 to turn off

Duration [in seconds] until a cached record is marked as outdated in the UBIK® Kernel

appSettings LogLevel The LogLevel should be changed accordingly in the Logging.config. LogLevel switch 0, No logging, switch 10, Simple logging, switch 20, Detailed logging.
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 UserRestrictive If this switch is 1, only known logins may connect to UBIK®.
If it is set to 0, every login may connect.
appSettings DeviceRestrictive If this switch is 1, only known and active devices may connect to UBIK®.
If it is set to 0, every device may connect.
appSettings TokenRestrictive If this switch is 1, data access is only possible after a successfull authentication.
If it is set to 0, the token is not validated.
appSettings GroupRightsUpdateIntervall GroupRightsUpdateIntervall setting is optional. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the ValityPeriode is used for defining the interval for the Rights Evaluator.
appSettings SessionManagementType Configure the type of session management the current service should use:
0 = Single Local Management / 1 = Local Application Service / 2 = Global Application Service
appSettings SessionManagementUrl In the case of SessionManagementType = 1 or 2, configure the URL of the application service via this setting.
If a port other than 443 (default port for https) is used, it has to be specified here as well.
appSettings HideAuthenticationInfo If this switch is 0, deliver error status if authentication fails, if it is set to 1, hide error status if authentication fails.

Examples

Example 1

  <appSettings>
    <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;User ID=myuser;Password=mypassword" />
    <add key="UBIK.Service.ValityPeriod" value="0" />
    <add key="UBIK.Service.TokenValityPeriod" value="300" />
    <add key="UBIK.Service.LogLevel" value="10" />
    <add key="UBIK.Service.UserRestrictive" value="1" />
    <add key="UBIK.Service.DeviceRestrictive" value="1" />
    <add key="UBIK.Service.TokenRestrictive" value="1" />
    <add key="UBIK.Service.LanguageID" value="0" />
    <add key="UBIK.Service.SessionManagementType" value="0" />
    <add key="UBIK.Service.SessionManagementUrl" value="" />
  </appSettings>

Example 2 (Windows Azure)

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

  <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" />
    <add key="UBIK.Service.ValityPeriod" value="0" />
    <add key="UBIK.Service.TokenValityPeriod" value="300" />
    <add key="UBIK.Service.LogLevel" value="10" />
    <add key="UBIK.Service.UserRestrictive" value="1" />
    <add key="UBIK.Service.DeviceRestrictive" value="1" />
    <add key="UBIK.Service.TokenRestrictive" value="1" />
    <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" />
  </appSettings>

Example 3 (Windows Authentication)

Integrated security.

  <appSettings>
    <add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Integrated Security=SSPI;" />
    <add key="UBIK.Service.ValityPeriod" value="0" />
    <add key="UBIK.Service.TokenValityPeriod" value="300" />
    <add key="UBIK.Service.LogLevel" value="10" />
    <add key="UBIK.Service.UserRestrictive" value="1" />
    <add key="UBIK.Service.DeviceRestrictive" value="1" />
    <add key="UBIK.Service.TokenRestrictive" value="1" />
    <add key="UBIK.Service.LanguageID" value="0" />
    <add key="UBIK.Service.HideAuthenticationInfo" value"1"/>
    <add key="UBIK.Service.SessionManagementType" value="0" />
    <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=24787"