Versions Compared

Old Version 10

changes.mady.by.user Mark Fitzpatrick

Saved on

compared with

New Version 11

changes.mady.by.user Mark Fitzpatrick

Saved on

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. Adding an adaptor to a zone using the YOUnite UI or YOUnite API
  6. Configure the adaptor
  7. Start the adaptor So It Can Connect so it can connect to the Hub
  8. Manage the adaptorPAUSE Change an adaptorPLAY an adaptor
  9. PLAY
    10. PLAY Read Only's state
    1. Pause
    2. Play
    3. Play Read Only
  10. Manage the adaptor
    1. Delete an Adaptor
    2. Get new Credentials for an adaptor

...

The response would look similar to:

Code Block
languagejs
{
TODO
    "uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a",
    "zoneUuid": "661f5d76-6bc7-4fc0-97fd-f331ab683379",
    "clientId": "64ed6954-3987-4020-9553-54d9e4e7d258",
    "clientSecret": "76e33a67-8e8c-4209-ae38-5e4fa59fd452"
}



Configuring an Adaptor

Properties from the above response body and other information need to be added to the adaptor's TODO file:

...

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.


Start the Adaptor - Connect to the Hub

Controlling an Adaptor

Pause an Adaptor

...

Once the adaptor has been added and configured, it can be launced. It should successfully connect to the hub and move briefly into the "Configured" state and then into the "Play" state unless otherwise configured.

TODO KEVIN: Debugging

Change an adaptor's state

An adaptor state can be changed using the PUT /zones/zone-uuid/adaptors/adaptors-uuid request. Before making a request, the adaptor's changeVersion needs to be retrieved by peforming a GET on the adaptor:


GET /zones/3c9000a9-3eb6-41fe-a11b-5a5859020c65/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a

A response that includes the adaptor's changeVersion is returned:

Code Block
languagejs
{
    "uuid": "3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a",
    "name": "Test Adaptor1",
    "zoneUuid": "3c9000a9-3eb6-41fe-a11b-5a5859020c65",
    "state": "ADAPTOR_POSTED",
    "dateCreated": 1503634367407,
    "lastUpdated": 1503635641288,
    "changeVersion": 4117664412
}

Pause 

The following request will change an adaptor's state to "pause": 

PUT /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a

Code Block
languagejs
{
	"state": "ADAPTOR_PAUSE",
	"changeVersion": 4117664412
}

Play 

The following request will change an adaptor's state to "play": 

PUT /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a

Code Block
languagejs
{
	"state": "ADAPTOR_PLAY",
	"changeVersion": 4117664412
}

Play Read Only

The following request will change an adaptor's state to "play read only": 

PUT /zones/661f5d76-6bc7-4fc0-97fd-f331ab683379/adaptors/3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a

Code Block
languagejs
{
	"state": "ADAPTOR_PLAY_RO",
	"changeVersion": 4117664412
}

Manage an Adaptor


Deleting an Adaptor


Get New Credentials for an Adaptor