Difference between revisions of "Configuration Files/AppSettings.config"
| Line 13: | Line 13: | ||
| appSettings|| UBIK.Service.ValidityPeriod || 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.ValidityPeriod || 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 | Duration [in seconds] until a cached record is marked as outdated in the {{UBIK}} Kernel | ||
| + | |- | ||
| + | | appSettings|| UBIK.Service.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|| 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 ||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 22: | Line 24: | ||
| appSettings|| UBIK.Service.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.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.GroupRightsUpdateIntervall ||''' GroupRightsUpdateIntervall setting is optional'''. Update Interval [in seconds] for the Group Rights Evaluator. If this setting is not configured, the | + | | 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.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.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 | ||
Revision as of 06:51, 16 April 2024
The data and session management service of the web service are configured in this file.
[edit]
Settings
| Area | Setting | Description |
|---|---|---|
| appSettings | UBIK.DataBase.ConnectionString | Configuration of the SQL connect string to the UBIK® Database |
| appSettings | UBIK.Service.ValidityPeriod | 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 | UBIK.Service.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 | 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.UserRestrictive | If this switch is 1, only known logins may connect to UBIK®. If it is set to 0, every login may connect. |
| appSettings | UBIK.Service.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 | UBIK.Service.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 | 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.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 | UBIK.Service.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 | UBIK.Service.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.ValidityPeriod" value="0" />
<add key="UBIK.Service.TokenValidityPeriod" 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>
<add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;User ID=myuser;Password=mypassword" />
<add key="UBIK.Service.ValidityPeriod" value="0" />
<add key="UBIK.Service.TokenValidityPeriod" 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.ValidityPeriod" value="0" />
<add key="UBIK.Service.TokenValidityPeriod" 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>
<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.ValidityPeriod" value="0" />
<add key="UBIK.Service.TokenValidityPeriod" 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.ValidityPeriod" value="0" />
<add key="UBIK.Service.TokenValidityPeriod" 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>
<add key="UBIK.DataBase.ConnectionString" value="Data Source=ubikdbserver.mydomain;Initial Catalog=UBIK.MYDATABASE;Integrated Security=SSPI;" />
<add key="UBIK.Service.ValidityPeriod" value="0" />
<add key="UBIK.Service.TokenValidityPeriod" 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>
 | The port number myport must be specified only if other than 443. |
