Changes
{{Version/ServerSince|3.6.0}} The Data Import Service is a interface consisting of a web service, hosted on an IIS service, which takes data pushed to Ubik and imports it efficiently. The heart of the service is a shared module called the Import MechanismSystem, which can be used to import data from whatever source they come, easing future interface developments. The system is highly customizable via Ubik Plugins to fit most use cases.
In detail, the service consists of three major parts:
This request also expects some Authentication data, which are completely dependent on the customized implementation provided via plugins.
If you want to develop an interface to get data from your 3rd party system to Ubik, you might want to consider using this system as well. It's easy to set up and requires minimal configuration on the Ubik side.
== Authentication System ==
== Import System ==
The Import System is the heart of the entire system. It is responsible for creating Ubik objects out of raw data, via proxies.
In its ideal use case, the interface runs the following steps:
* Creating <code>ImportObject</code> derivate out of the raw data
* Loading <code>ImportProcessor</code> derivate supporting the type of <code>ImportObject</code>
* Validating the <code>ImportObject</code> with the <code>ImportProcessor</code>
* Writing the <code>ImportObject</code> to a new or existing Proxy instance
* Saving the Proxy
* Async bulk-import of Proxy to create Ubik object
* Once finished and new items are queued, a new bulk-import will launch. If no import is queued, the customizable post processing method will be called.
Similarly to the Authentication System, this system can be customized via Plugins as well. Providing a custom <code>ImportProcessor</code> derivate with the target type set to a custom <code>ImportObject</code> derivate makes this processor available to be used to fit a use-case.
The Import System can be used by itself too, it's easy to integrate it to different interfaces. It can be made running synchronously as well, to be potentially even more efficient for specific custom implementations.
[[Category:Data Import Service|Data Import Service]]
[[Category:Plugin|Data Import Service]]
