Difference between revisions of "XML Interface Toolkit"

Revision as of 12: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.

The XML data file must use the correct encoding, e.g. UTF-8!

Workflow

Import

Create a XML data file to be imported in UBIK^® according to the description for the mapping configuration
Use the Interface Manager to create a proper interface command file specifying the required server parameters, folder and file locations
Manually start and test the import by executing the interface via the Interface Manager

Export

Use the Interface Manager to create a proper interface command file specifying the required server parameters, folder and file locations
Manually start and test the export by executing the interface via the Interface Manager

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	Defines a folder where temporary files will be placed and deleted after processing
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
DataObject	Export	Guid of a single UBIK^® object to be exported
DeleteFile	Import/Export	Defines whether or not the specified DataFile should be deleted after processing
LogFolder	Import/Export	Defines a folder where log files will be created into; if set a log file will be created always!
LogFile	Import/Export	Optional: defines a certain log file name; it not set the system will create an arbitrary one

Example: Export

Example: Import

Mapping configuration

The XML data is converted into according UBIK^® data (objects, property values,...) by applying a mapping between XML elements / attributes and UBIK^® MetaClasses / MetaProperties.

Sections of mapping file

A mapping configuration file consists of

two distinctive sections for the general import and export configuration, each consisting of
multiple sections for mapping of UBIK^® MetaClasses to XML elements, each consisting of
- a section to define possible key properties
- a section to define general properties
- a section to define references for objects
- a section to define relations between objects
- a section to define possible child objects

The mapping information must be enveloped by a XML tag <UbikXMLMap>!

General Import / Export configuration

Configuration of the general import and export mapping parameters

Attributes

Attribute	Values	Description
EvaluateReferences	0 or 1	Set to 1 if references shall be evaluated (default = 1)
EvaluateRelations	0 or 1	Set to 1 if relations shall be evaluated (default = 1)
DataEnvelope	Text	Specify XML envelope (root node, default = UbikXMLData)
EvaluateUTS	0 or 1	Set to 1 to export UpdateTimeStamp of objects (default = 0)

The default envelope for the XML data is <UbikXMLData> and can be modified via the mapping configuration settings.

Classes

XMLDataInterface

Process XML data and create or update UBIK^® objects
Process mapping information and apply on XML / UBIK^® data

namespace UBIK.Interface.Module.XML
public class XMLDataInterface : UBIKStandardInterface, IUBIKImport, IUBIKExport

XMLDataImport

Creates or update UBIK^® objects from XML data using a XML converter and XML mapping

namespace UBIK.Interface.Module.XML
public class XMLDataImport

XMLDataExport

Creates XML data from UBIK® objects using a XML converter and XML mapping

namespace UBIK.Interface.Module.XML
public class XMLDataExport

XMLConverter

Converts UBIK^® MetaClasses / MetaProperties into XML elements / attributes and vice versa
Translates XML items into UBIK^® content objects

namespace UBIK.Interface.Module.XML
public class XMLConverter

@@ Line 97: / Line 97: @@
 </source>
-== Mapping ==
+== Mapping configuration ==
 The XML data is converted into according {{UBIK}} data (objects, property values,...) by applying a mapping between XML elements / attributes and {{UBIK}} [[MetaClasses]] / [[MetaProperties]].
@@ Line 112: / Line 112: @@
 {{Attention|The mapping information must be enveloped by a XML tag <UbikXMLMap>!}}
-=== Import / Export Configuration ===
+=== General Import / Export configuration ===
 * Configuration of the general import and export mapping parameters
 <source lang="xml">