Versions Compared

Key

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

...

The workflow required in getting a fully functioning adaptor are as follows

  1. Register an Adaptor using the YOUnite API which will generate the necessary configuration details the Adaptor will need at startup time.
  2. Develop an adaptor in your development environment using a YOUnite Adaptor SDK (see YOUnite Adaptor Guide for Java Developers)
  3. Install Deploy the adaptor on a server (e.g. on a physical server, virtual server,  instance, container, etc.) that is connected has access to the YOUnite message bus
  4. Connect the adaptor to the native data store or service that it is connect to YOUnite  (e.g. CRM, MIS, SIS, DB, etc)
  5. Deploy the adaptor on a server (e.g. on a physical server, virtual server,  instance, container, etc.) that is connected the YOUnite message bus
  6. Adding an adaptor to a zone using the YOUnite UI or YOUnite API
  7. Configure the adaptorConfigure the adaptor with the details from the registration of the adaptor through the YOUnite API
  8. Start the adaptor so it can connect to the HubYOUnite DataHub using the YOUnite Message Bus
  9. Change an adaptor'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

...

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

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

...