Last modified on 12 May 2015, at 09:30

Web Service Configuration

Revision as of 09:30, 12 May 2015 by KNO (Talk | contribs)

The web service can be configured using the main configuration file web.config as well as the specific files.

Area Setting Description
appSettings UBIK.DataBase.ConnectionString Configuration of the SQL connect string to the UBIK® Database
appSettings UBIK.Service.MaxIdleMinutes Duration [in minutes] until a unused WebService shuts down automatically
appSettings UBIK.Service.ValityPeriode Duration [in seconds] until a cached record is marked as outdated in the UBIK Kernel
appSettings LogLevel LogLevel
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 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 EnableViewCache Enable = 1 / Disable = 0 the View Cache feature
loggingConfiguration listeners Full configuration of the UBIK® Logging
requestLimits maxAllowedContentLength Configure the maximum allowed length of received content (see Example)

Example

  <appSettings>
    <add key="UBIK.DataBase.ConnectionString" value="Data Source=UBIK_SQL_SERVER;Initial Catalog=UBIK;Persist Security Info=True;User ID=ubik;Password=password" />
    <add key="UBIK.Service.MaxIdleMinutes" value="5" />
    <add key="UBIK.Service.ValityPeriode" value="30" />
    <add key="UBIK.Service.LogLevel" value="10" />
    <add key="UBIK.Service.LanguageID" value="1" />
    <add key="UBIK.Service.UserRestrictive" value="1" />
    <add key="UBIK.Service.DeviceRestrictive" value="0" />
    <add key="UBIK.Service.TokenRestrictive" value="1" />
    <add key="UBIK.Service.SessionManagementType" value="1" />
    <add key="UBIK.Service.SessionManagementUrl" value="https://SERVERNAME[:PORT]/UBIK/USAM.svc/SOAP" />
  </appSettings>
IC Hint square.pngThe port number PORT must be specified only if other than 443 (default for https).

See also