Difference between revisions of "XML Interface Toolkit"

Revision as of 09:35, 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	Name of the SQL Server (DataSource)
InitialCatalog	Import/Export	The name of the instance on the SQL Server (DataBase)
UserID	Import/Export	SQL Server user name (User)
Password	Import/Export	SQL Server password (Password)
RecordLifeTime	Import/Export	Duration how long records are valid before they will be requeried for changes by the kernel; -1 to turn off
WorkingFolder	Import/Export
DataFile	Import/Export	Import: File path to XML data file to be imported; Export: Exported XML data will be stored in this file
DataMappingFile	Import/Export
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 9: / Line 9: @@
 ! Key!! Application!! Description
 |-
-| Server || Import/Export ||Configuration of the SQL connect string to the UBIK Database
+| Server || Import/Export || Name of the SQL Server (DataSource)
 |-
-| InitialCatalog || Import/Export ||Duration [in minutes] until a unused WebService shuts down automatically
+| InitialCatalog || Import/Export || The name of the instance on the SQL Server (DataBase)
 |-
-| UserID || Import/Export ||Duration [in seconds] until a cached record is marked as outdated in the UBIK Kernel
+| UserID || Import/Export || SQL Server user name (User)
 |-
-| Password || Import/Export ||LogLevel
+| Password || Import/Export || SQL Server password (Password)
 |-
-| RecordLifeTime || Import/Export ||Set how long records are valid before they will be requeried for changes by the kernel; -1 to turn off
+| RecordLifeTime || Import/Export || Duration 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.
+| WorkingFolder || Import/Export ||
 |-
-| 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.
+| DataFile || Import/Export || Import: File path to XML data file to be imported; Export: Exported XML data will be stored in this file
 |-
-| 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.
+| DataMappingFile || Import/Export ||
 |-
 | DataView || Export ||Configure the type of Sessionmanagement the current Service should use 0 = local management, 1 = Local Application Service, 2 = Global Applicatoin Service