Jump to: navigation, search

Difference between revisions of "Web Service Configuration"

 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
The web service must be configured by updating the ''Web.Config'' file. See [[Web_Service_Configuration_Example|web.config examples]] for a service configuration file.
+
== Specific Configuration Files ==
 +
The specific configuration files are considered in the configuration via inclusion. For example, the tag ''<bindings configSource="Logging.config" />'' in the main configuration file adds all settings of ''Logging.config'' to the configuration.  
  
−
{| class="wikitable" | width = "88%"
+
Specific files are available for:
−
|-
+
* '''Bindings''': different configurations for data services and endpoints
−
! Area!! Setting!! Description
+
* '''Clients''': definitions used by the data service for connecting to the [[USAM|session management service]]
−
|-
+
* '''Logging''': configuration of destination paths, etc.
−
| appSettings|| UBIK.DataBase.ConnectionString ||Configuration of the SQL connect string to the {{UBIK}} Database
+
* '''Services''': used by the data service and the session management service
−
|-
+
* '''Application Settings''': configuration of the data and session management service of the web service
−
| appSettings|| UBIK.Service.MaxIdleMinutes ||Duration [in minutes] until a unused WebService shuts down automatically
+
* '''Web Settings''': configuration of the web site.
−
|-
+
−
| 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}}.<br/>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.<br/>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.<br/>If it is set to '''0''', the token is not validated.
+
−
|-
+
−
| 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|| 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
+
−
|-
+
−
|-
+
−
| requestLimits || maxAllowedContentLength || Configure the maximum allowed length of received content (see [[Web_Service_Configuration_Example#system.webServer|Example]])
+
−
|-
+
−
|}
+
  
−
==Example==
+
This table shows by which component the specific files are used.
−
<source lang="xml">
+
<table class="defaultTable sortable">
−
  <appSettings>
+
{{Item/ConfigFileHeader}}
−
    <add key="UBIK.DataBase.ConnectionString" value="Data Source=UBIK_SQL_SERVER;Initial Catalog=UBIK;Persist Security Info=True;User ID=ubik;Password=password" />
+
{{Item/ConfigFile|Application settings|[[Configuration_Files/AppSettings.config|AppSettings.config]]|1||}}
−
    <add key="UBIK.Service.MaxIdleMinutes" value="5" />
+
{{Item/ConfigFile|Bindings|[[Configuration_Files/Bindings.config|Bindings.config]]|1|1|1}}
−
    <add key="UBIK.Service.ValityPeriode" value="30" />
+
{{Item/ConfigFile|Clients|[[Configuration_Files/Client.config|Client.config]]|1|1|1}}
−
    <add key="UBIK.Service.LogLevel" value="10" />
+
{{Item/ConfigFile|Logging|[[Configuration_Files/Logging.config|Logging.config]]|1|1|1}}
−
    <add key="UBIK.Service.LanguageID" value="1" />
+
{{Item/ConfigFile|Services|[[Configuration_Files/Services.config|Services.config]]|1||}}
−
    <add key="UBIK.Service.UserRestrictive" value="1" />
+
{{Item/ConfigFile|Web|[[Configuration_Files/web.config|Web.config]]|1|1|1}}
−
    <add key="UBIK.Service.DeviceRestrictive" value="0" />
+
</table>
−
    <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>
+
−
</source>
+
−
{{Hint|The port number ''PORT'' must be specified only if other than 443 (default for https).}}
+
  
−
== See also ==
+
The configuration file of the web service additionally needs to obey rules as given in [http://msdn.microsoft.com/en-us/library/ms733830%28v=vs.110%29.aspx Configuring Services].
−
* [[Configuration File Example]]
+
  
−
[[Category:Web Service]]
+
Common sections, existing in all main configuration files and should not be changed in general, are
 +
* '''<configSections>''': these settings include general logging and exception handling
 +
* '''<exceptionHandling>''': detailed configuration of exception handling
 +
* '''<loggingConfiguration>''': detailed configuration of logging
 +
* '''<system.serviceModel>''': behaviours for services and endpoints
 +
 
 +
[[Category:Installing|Web Service Configuration]]
 +
[[Category:Web service|Web Service Configuration]]

Latest revision as of 10:35, 7 July 2023

Specific Configuration Files

The specific configuration files are considered in the configuration via inclusion. For example, the tag <bindings configSource="Logging.config" /> in the main configuration file adds all settings of Logging.config to the configuration.

Specific files are available for:

  • Bindings: different configurations for data services and endpoints
  • Clients: definitions used by the data service for connecting to the session management service
  • Logging: configuration of destination paths, etc.
  • Services: used by the data service and the session management service
  • Application Settings: configuration of the data and session management service of the web service
  • Web Settings: configuration of the web site.

This table shows by which component the specific files are used.

DescriptionExample fileWeb serviceStudioEnterprise Service
Application settingsAppSettings.configIC Bullet Full.png--
BindingsBindings.configIC Bullet Full.pngIC Bullet Full.pngIC Bullet Full.png
ClientsClient.configIC Bullet Full.pngIC Bullet Full.pngIC Bullet Full.png
LoggingLogging.configIC Bullet Full.pngIC Bullet Full.pngIC Bullet Full.png
ServicesServices.configIC Bullet Full.png--
WebWeb.configIC Bullet Full.pngIC Bullet Full.pngIC Bullet Full.png

The configuration file of the web service additionally needs to obey rules as given in Configuring Services.

Common sections, existing in all main configuration files and should not be changed in general, are

  • <configSections>: these settings include general logging and exception handling
  • <exceptionHandling>: detailed configuration of exception handling
  • <loggingConfiguration>: detailed configuration of logging
  • <system.serviceModel>: behaviours for services and endpoints
Retrieved from "https://wiki.augmensys.com/index.php?title=Web_Service_Configuration&oldid=24790"