Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Develop an adaptor in your development environment using a YOUnite Adaptor SDK (see YOUnite Adaptor Guide for Java Developers)
  2. Install the adaptor on a server (e.g. on a physical server, virtual server,  instance, container, etc.) that is connected the YOUnite message bus
  3. Connect the adaptor to the native data store or service that it is connect to YOUnite  (e.g. CRM, MIS, SIS, DB, etc)
  4. Deploy the adaptor on a server (e.g. on a physical server, virtual server,  instance, container, etc.) that is connected the YOUnite message bus
  5. POST the adaptor Adding an adaptor to a zone using the YOUnite UI or YOUnite API
  6. Configure the adaptor
  7. Start the adaptor and allow it to connect to the YOUnite DataHub
  8. 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. 

Deploy the Adaptor

Adaptors States

...

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. 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. 


StateDescription
PostedAdaptor 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
PauseThe adaptors is running but not accepting adaptor (read/write) requests.

Play Read-Only

The adaptor is accepting read requests only.
PlayThe adaptor is accepting read and write requests.


Posting and Configuring an Adaptor 

...