Difference between revisions of "XML Interface Toolkit"

Revision as of 09:30, 11 February 2014

The XML interface toolkit provides mechanisms to import and export data in XML format. Arbitrary structured XML data is mapped to according UBIK^® objects and its properties by a mapping specified in a separate mapping configuration file. Both files have to be specified in the interface command file additional to the default parameters.

Parameters

The general parameters, marked by Import/Export, are equivalents of the settings used by UBIKSTUDIO to connect to a database, please refer to its settings section for a detailed description.

Command file

Key	Application	Description
Server	Import/Export	Configuration of the SQL connect string to the UBIK Database
InitialCatalog	Import/Export	Duration [in minutes] until a unused WebService shuts down automatically
UserID	Import/Export	Duration [in seconds] until a cached record is marked as outdated in the UBIK Kernel
Password	Import/Export	LogLevel
RecordLifeTime	Import/Export	Set how long records are valid before they will be requeried for changes by the kernel; -1 to turn off
WorkingFolder	Import/Export	If this switch is "1", only known logins may connect to UBIK. If it is set to "0", every login may connect.
DataFile	Import/Export	If this switch is "1", only known and active devices may connect to UBIK. If it is set to "0", every device may connect.
DataMappingFile	Import/Export	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.
DataView	Export	Configure the type of Sessionmanagement the current Service should use 0 = local management, 1 = Local Application Service, 2 = Global Applicatoin Service
DeleteFile	Import/Export	In the case of SessionManagementType = 1 or 2, configure the Url of the Applicatoin service via this setting
LogFolder	Import/Export	Full configuration of the UBIK Logging
LogFile	Import/Export	Configure the maximum allowed length of received content (see Example)

Example: Export

Example: Import

Mapping file

@@ Line 1: / Line 1: @@
-The XML interface toolkit provides mechanisms to import and export data in XML format. Arbitrary structured XML data is mapped to according {{UBIK}} objects and its properties by a mapping specified in a separate mapping configuration file. Both files have to be specified in the interface command file additional to the default [[Interface_Manager#Configuration|configuration]].
+The XML interface toolkit provides mechanisms to import and export data in XML format. Arbitrary structured XML data is mapped to according {{UBIK}} objects and its properties by a mapping specified in a separate mapping configuration file. Both files have to be specified in the interface command file additional to the [[Interface_Manager#Configuration|default parameters]].
+== Parameters ==
+The general parameters, marked by Import/Export, are equivalents of the settings used by {{UBIKSTUDIO}} to connect to a database, please refer to its [[UBIK_Studio_Basics#Settings|settings section]] for a detailed description.
 == Command file ==
-The Web Service must be configured by updating the ''Web.Config'' File. See web.config [[UBIK_Web_Service_Configuration_Example|Examples]] to see an example for a service configuration file.
 {| class="wikitable" | width = "88%"
 |-
-! Key!! Value!! Description
+! Key!! Application!! Description
 |-
-| Server || UBIK.DataBase.ConnectionString ||Configuration of the SQL connect string to the UBIK Database
+| Server || Import/Export ||Configuration of the SQL connect string to the UBIK Database
 |-
-| InitialCatalog || UBIK.Service.MaxIdleMinutes ||Duration [in minutes] until a unused WebService shuts down automatically
+| InitialCatalog || Import/Export ||Duration [in minutes] until a unused WebService shuts down automatically
 |-
-| UserID || UBIK.Service.ValityPeriode ||Duration [in seconds] until a cached record is marked as outdated in the UBIK Kernel
+| UserID || Import/Export ||Duration [in seconds] until a cached record is marked as outdated in the UBIK Kernel
 |-
-| Password || LogLevel ||LogLevel
+| Password || Import/Export ||LogLevel
 |-
-| RecordLifeTime || 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.
+| RecordLifeTime || Import/Export ||Set how long records are valid before they will be requeried for changes by the kernel; -1 to turn off
 |-
-| WorkingFolder || UserRestrictive ||If this switch is "1", only known logins may connect to UBIK. If it is set to "0", every login may connect.
+| WorkingFolder || Import/Export ||If this switch is "1", only known logins may connect to UBIK. If it is set to "0", every login may connect.
 |-
-| DataFile || 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.
+| DataFile || Import/Export ||If this switch is "1", only known and active devices may connect to UBIK. If it is set to "0", every device may connect.
 |-
-| DataMappingFile || 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.
+| DataMappingFile || Import/Export ||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.
 |-
-| DataView || SessionManagementType ||Configure the type of Sessionmanagement the current Service should use 0 = local management, 1 = Local Application Service, 2 = Global Applicatoin Service
+| DataView || Export ||Configure the type of Sessionmanagement the current Service should use 0 = local management, 1 = Local Application Service, 2 = Global Applicatoin Service
 |-
-| DeleteFile || SessionManagementUrl||In the case of SessionManagementType = 1 or 2, configure the Url of the Applicatoin service via this setting
+| DeleteFile || Import/Export||In the case of SessionManagementType = 1 or 2, configure the Url of the Applicatoin service via this setting
 |-
-| LogFolder || listeners ||Full configuration of the UBIK Logging
+| LogFolder || Import/Export ||Full configuration of the UBIK Logging
 |-
-| LogFile || maxAllowedContentLength || Configure the maximum allowed length of received content (see [[UBIK_Web_Service_Configuration_Example#system.webServer|Example]])
+| LogFile || Import/Export|| Configure the maximum allowed length of received content (see [[UBIK_Web_Service_Configuration_Example#system.webServer|Example]])
 |-
 |}