Difference between revisions of "XML Interface Toolkit"

Revision as of 09:40, 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.

The parameter DataView is used only for export purposes and defines the name of a UBIK^® view object. In an export process the XML toolkit

evaluates the view hierarchy and its objects
exports an object as defined in the mapping
in the same hierarchy as placed in the view

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	File path to file containing the XML mapping information, both for import as well as export
DataView	Export	Name of a UBIK^® view object defining the scope and hierarchy of exported objects
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 3: / Line 3: @@
 == 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.
+The parameter ''DataView'' is used only for export purposes and defines the name of a {{UBIK}} view object. In an export process the XML toolkit
+* evaluates the view hierarchy and its objects
+* exports an object as defined in the mapping
+* in the same hierarchy as placed in the view
 {| class="wikitable" | width = "88%"
@@ Line 22: / Line 27: @@
 | 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 ||
+| DataMappingFile || Import/Export || File path to file containing the XML mapping information, both for import as well as export
 |-
-| DataView || Export ||Configure the type of Sessionmanagement the current Service should use 0 = local management, 1 = Local Application Service, 2 = Global Applicatoin Service
+| DataView || Export || Name of a {{UBIK}} view object defining the scope and hierarchy of exported objects
 |-
 | DeleteFile || Import/Export||In the case of SessionManagementType = 1 or 2, configure the Url of the Applicatoin service via this setting