...
Developing adaptors can be found on the YOUnite Adaptor Guide for Java Developers page.
The YOUnite API Documentation can be found at https://younite.us/api
...
Adaptor Workflow
The workflow required in getting a fully functioning adaptor are as follows
- Develop an adaptor in your development environment using a YOUnite Adaptor SDK (see YOUnite Adaptor Guide for Java Developers)
- Install the adaptor on a server (e.g. on a physical server, virtual server, instance, container, etc.) that is connected the YOUnite message bus
- Connect the adaptor to the native data store or service that it is connect to YOUnite (e.g. CRM, MIS, SIS, DB, etc)
- Deploy the adaptor on a server (e.g. on a physical server, virtual server, instance, container, etc.) that is connected the YOUnite message bus
- Adding an adaptor to a zone using the YOUnite UI or YOUnite API
- Configure the adaptor
- Start the adaptor and allow it to connect So It Can Connect to the YOUnite DataHubHub
- Manage the adaptor
- PAUSE an adaptor
- PLAY an adaptor
- PLAY
- PLAY Read Only
- Delete an Adaptor
- Get new Credentials for an adaptor
The first step is covered in the adaptor guide and steps two through four are implementation specific. The remainder of this page covers steps five through eight.
Adding an Adaptor
Adding an adaptor merely informs the hub that there is an intention to add an adaptor to a zone. Only users with POST /zones/zone-uuid/adaptors permissions can add in adaptor to a zone. By default only the zone data steward (ZDS) has this permission.
All that is required to POST an adaptor is an adaptor name. If the request succeeds, an adaptor UUID and security credentials are returned.
POST /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors
| Code Block | ||
|---|---|---|
| ||
{
"name": "My First Adaptor"
} |
The response would look similar to:
| Code Block | ||
|---|---|---|
| ||
{
TODO
} |
Configuring an Adaptor
Properties from the above response body and other information need to be added to the adaptor's TODO file:
TODO: TABLE of KEY: VALUES
Example:
| Code Block |
|---|
Adaptors States
Once an adaptor is added it is in the "Posted" state. The adaptors moves between states as follows:
| State | Description |
|---|---|
| Posted | Adaptor is successfully POSTed. An API consumer can make this request or it can be done through the YOUnite UI. |
| Configured | The adaptors had a:
|
| Pause | The adaptors is running but not accepting adaptor (read/write) requests. |
Play Read-Only | The adaptor is accepting read requests only. |
| Play | The adaptor is accepting read and write requests. |
Posting and Configuring an Adaptor
By default only the zone data steward role has permission to create an adaptor and view its credentials. User must have XX permission.
UI screenshots. Router doc (ADAPTOR: POST & CONFIGURATION)
Adaptor Startup Sequence
Controlling an Adaptor
Permissions needed
U Screen shots
API endpoints
Updating an Adaptor
...