Difference between revisions of "XML Interface Toolkit"
| 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]]. | |
== Command file == | == Command file == | ||
Revision as of 09:24, 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 configuration.
Command file
The Web Service must be configured by updating the Web.Config File. See web.config Examples to see an example for a service configuration file.
| Key | Value | Description |
|---|---|---|
| Server | UBIK.DataBase.ConnectionString | Configuration of the SQL connect string to the UBIK Database |
| InitialCatalog | UBIK.Service.MaxIdleMinutes | 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 |
| Password | LogLevel | 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. |
| WorkingFolder | UserRestrictive | 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. |
| 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. |
| DataView | SessionManagementType | 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 |
| LogFolder | listeners | Full configuration of the UBIK Logging |
| LogFile | maxAllowedContentLength | Configure the maximum allowed length of received content (see Example) |
Example: Export
<InterfaceManager>
<Commands>
<Interface FullName="UBIK.Interface.Module.XML, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" File="C:\UBIK\Studio\Interfaces\UBIK.Interface.Module.XML.dll" Class="UBIK.Interface.Module.XML.XMLDataInterface" Direction="E">
<Parameter Key="Server" Value="sqlserver" />
<Parameter Key="InitialCatalog" Value="ubik" />
<Parameter Key="UserID" Value="sa" />
<Parameter Key="Password" Value="sa" />
<Parameter Key="RecordLifeTime" Value="-1" />
<Parameter Key="WorkingFolder" Value="C:\UBIK\Xml\Work" />
<Parameter Key="DataFile" Value="C:\UBIK\Xml\Data\data.xml" />
<Parameter Key="DataMappingFile" Value="C:\UBIK\Xml\Map\map.xml" />
<Parameter Key="DataView" Value="VIE_EXPORT" />
<Parameter Key="DeleteFile" Value="0" />
<Parameter Key="LogFolder" Value="C:\UBIK\Log\Temp" />
<Parameter Key="LogFile" Value="export.log" />
</Interface>
</Commands>
</InterfaceManager>
<Commands>
<Interface FullName="UBIK.Interface.Module.XML, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" File="C:\UBIK\Studio\Interfaces\UBIK.Interface.Module.XML.dll" Class="UBIK.Interface.Module.XML.XMLDataInterface" Direction="E">
<Parameter Key="Server" Value="sqlserver" />
<Parameter Key="InitialCatalog" Value="ubik" />
<Parameter Key="UserID" Value="sa" />
<Parameter Key="Password" Value="sa" />
<Parameter Key="RecordLifeTime" Value="-1" />
<Parameter Key="WorkingFolder" Value="C:\UBIK\Xml\Work" />
<Parameter Key="DataFile" Value="C:\UBIK\Xml\Data\data.xml" />
<Parameter Key="DataMappingFile" Value="C:\UBIK\Xml\Map\map.xml" />
<Parameter Key="DataView" Value="VIE_EXPORT" />
<Parameter Key="DeleteFile" Value="0" />
<Parameter Key="LogFolder" Value="C:\UBIK\Log\Temp" />
<Parameter Key="LogFile" Value="export.log" />
</Interface>
</Commands>
</InterfaceManager>
Example: Import
<InterfaceManager>
<Commands>
<Interface FullName="UBIK.Interface.Module.XML, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" File="C:\UBIK\Studio\Interfaces\UBIK.Interface.Module.XML.dll" Class="UBIK.Interface.Module.XML.XMLDataInterface" Direction="I">
<Parameter Key="Server" Value="sqlserver" />
<Parameter Key="InitialCatalog" Value="ubik" />
<Parameter Key="UserID" Value="sa" />
<Parameter Key="Password" Value="sa" />
<Parameter Key="RecordLifeTime" Value="-1" />
<Parameter Key="WorkingFolder" Value="C:\UBIK\Xml\Work" />
<Parameter Key="DataFile" Value="C:\UBIK\Xml\Data\data.xml" />
<Parameter Key="DataMappingFile" Value="C:\UBIK\Xml\Map\map.xml" />
<Parameter Key="DataView" Value="" />
<Parameter Key="DeleteFile" Value="0" />
<Parameter Key="LogFolder" Value="C:\UBIK\Log\Temp" />
<Parameter Key="LogFile" Value="import.log" />
</Interface>
</Commands>
</InterfaceManager>
<Commands>
<Interface FullName="UBIK.Interface.Module.XML, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" File="C:\UBIK\Studio\Interfaces\UBIK.Interface.Module.XML.dll" Class="UBIK.Interface.Module.XML.XMLDataInterface" Direction="I">
<Parameter Key="Server" Value="sqlserver" />
<Parameter Key="InitialCatalog" Value="ubik" />
<Parameter Key="UserID" Value="sa" />
<Parameter Key="Password" Value="sa" />
<Parameter Key="RecordLifeTime" Value="-1" />
<Parameter Key="WorkingFolder" Value="C:\UBIK\Xml\Work" />
<Parameter Key="DataFile" Value="C:\UBIK\Xml\Data\data.xml" />
<Parameter Key="DataMappingFile" Value="C:\UBIK\Xml\Map\map.xml" />
<Parameter Key="DataView" Value="" />
<Parameter Key="DeleteFile" Value="0" />
<Parameter Key="LogFolder" Value="C:\UBIK\Log\Temp" />
<Parameter Key="LogFile" Value="import.log" />
</Interface>
</Commands>
</InterfaceManager>
