| Table of Contents |
|---|
...
YOUnite Adaptors are essentially extensions to the YOUnite Data Hub, allowing access to managed data. Third parties implement these adaptors using the YOUnite Adaptor SDK. Adaptors are a fundamental component to federated data domains.
Additionally, an Adaptor is software located within a system that shares data through the YOUnite Data Hub and acts as the connection point between that system and the Data Hub. An adaptor focuses on ETL (Extract, Transform, and Load) and CRUD functions, ensuring the outbound data from that system meets the format requirements of the Data Hub and transforming the inbound data from the hub into what any other system requires. It may have additional business logic such as filtering for specific data from the Data Hub.
...
For more information on YOUnite adaptors see:
...
The YOUnite API Documentation can be found at https://younite.us/api
...
How to Get Started With the YOUnite SDK
To implement an adaptor you use the YOUnite Adaptor SDK (SDK). The SDK handles much of the behind-the-scenes complexity, but developers still need to manage: configuration elements, the life cycle, and the proper use of the SDK Annotations.
...
| Code Block |
|---|
<repositories> <repository> <id>younite-snapshots</id> <name>younite</name> <url>https://younite.bintray.com/</url> <snapshots> <enabled>true</enabled> </snapshots> </repository> </repositories> |
...
Once an adaptor is connected to the YOUnite Data Hub through the YOUnite Message Bus, it is able to send and receive data and ops messages. The SDK has minimal configuration steps, allowing developers to focus on their adaptor's business logic instead of the inner workings of sending and receiving messages, parsing those messages, etc. To facilitate getting your adaptor up and running, the YOUnite Adaptor SDK makes use of annotations. Developers use these annotations to define the adaptor's capabilities: what their adaptor can produce and/or consume. Capabilities loosely translate into a Pub/Sub configuration on the YOUnite Data Hub.
...
As mentioned previously, when an adaptor is started (by calling the AdaptorSDK.init() method), it builds the list of capabilities that it must send to the YOUnite Data Hub. The Adaptor Capabilities List consists of the capabilities an adaptor declares to the YOUnite Data Hub upon initialization that 1) link records in the underlying application/service to YOUnite data records, 2) POST entries in the underlying application/service that link to YOUnite data records, and 3) manipulate data in the underlying service.
The capabilities list lets the Data Hub know:
...
We are defining which properties of a specified domain/version the adaptor is able to work with. The
The YOUnite Adaptor SDK provides a set of annotations for annotating methods within an annotated Adaptor class. The annotation properties indicate the domain's name, version, and properties names within the domain that the annotated method expects as input or returns as output.
...
Here is a list of examples provided via the <portal? sdk.zip outside of maven? link to github projects??> with information on each.
TBD...