Managing Adaptors

Introductions to Adaptors can be found on the Introduction to YOUnite page and the Adaptors page.

Developing adaptors can be found on the YOUnite Adaptor Guide for Java Developers page.

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 to the YOUnite DataHub
Manage the adaptor
1. PAUSE an adaptor
2. PLAY an adaptor
  1. PLAY
  2. PLAY Read Only
3. Delete an Adaptor
4. 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. If the request succeeds, an adaptor UUID and security credentials are returned:

Adaptors States

Once an adaptor is added it is in the "Posted" state.

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: Successful connection to the YOUnite Datahub via the message bus/broker Subscribed to the appropriate message broker topics Its message broker queue has been created
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