...
The workflow required in getting a fully functioning adaptor are as follows
- Add an Adaptor using Type using the YOUnite API, which will generate the necessary configuration details the Adaptor will need UI's Adaptor Types page (or YOUnite API endpoint /adaptorTypes). Adaptor types are not required since all adaptor will default to the "default" adaptor type. Adaptor types are designed to make configuring an adaptor easier especially for deployments that will be deploying many adaptors of the same type.
- Follow the adaptor's README on where to load the adaptor software on the instance (e.g. docker image, VM, cloud instance, local system).
- In the YOUnite UI Adaptor's page (or YOUnite API endpoint /zones/<target-zone-uuid>/adaptors ) add the adaptor to the target zone specifying the adaptor's type (or just specify the "default" type).
- The prior step will generate the necessary configuration (UUID, clientId and clientSecret for connecting to the message bus), the Adaptor will need these at startup time.
- Develop an adaptor in your development environment using a YOUnite Adaptor SDK (see YOUnite Adaptor Guide for Java Developers).
- Deploy the adaptor on a server (e.g. on a physical server, virtual server, instance, container, etc.) that has access to 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.).
- Configure the adaptor with the details from step 1 "Register an Adaptor" above.
- Start the adaptor so it can connect to the YOUnite DataHub over the YOUnite Message Bus.
- Change an adaptor's state.
- Pause
- Play
- Play Read Only
- Manage the adaptor.
- Delete an Adaptor
- Get new Credentials for an adaptor
Step 1 ("Adding an Adaptor") and steps 5 through 8 are covered on this page. Steps 2 through 4 are implementation-specific.
A. Develop an adaptor in your development environment using a YOUnite Adaptor SDK (see YOUnite Adaptor Guide for Java Developers).
B.
C.
1. Adding an Adaptor
Adding an adaptor merely informs the Data 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.
...
| 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 adaptor has:
|
| Pause | The adaptor 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. |
An adaptor state can be changed using the request:
| Anchor | ||||
|---|---|---|---|---|
|
...
| Code Block | ||
|---|---|---|
| ||
DELETE /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a |
Note: When you delete an adaptor it is a soft delete (meaning the adaptor's "active" setting will be set to false). A soft-delete for entities avoids purging important information, including that which can be used to associate past activity in the system, such as logged events, zone, and adaptor type.
However, the linking (mapping) between the (YOUnite) Data Record and the source entities in the source system attached to the deleted adaptor will be hard deletes. Linking for deleted adaptors is hard-deleted as this particular data carries no useful additional data or metadata (the link entities are just an adaptorUuid and a drUuid). Post-delete, an adaptor's linking history can still be viewed in system logs that should include all the relevant details about that link, as well as a log timestamp.
Get Credentials for an Adaptor
...