...
- Register an Adaptor using the YOUnite API, which will generate the necessary configuration details the Adaptor will need 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
...
| Code Block | ||
|---|---|---|
| ||
# Configuration # Transport implementation class className: com.younite.adaptor.sdk.transport.amq.AMQConnect # UUID of the zone this adaptor belongs to zoneUuid: 6ab9380f-d7f2-477c-b93c-3a762e70095e # Adaptor UUID adaptorUuid: 3dfcc03d-e5d4-4d57-9e9b-5c5d2db32f9a # ClientID and Secret to be used by JMS to verify adaptor has valid access to message bus (and API) clientId: 8c9167a6-bb83-4f77-bdfc-1947a946f77b clientSecret: de02e3fa-4b23-46cb-aed6-5665a16e73d3 # Message Broker URL brokerUrl: nio+ssl://192.2.200.25:61617 # OAUTH Server to validate adaptor access credentials oauthServerUrl: http://192.2.200.15:8080 |
6. Start the Adaptor - Connect to the Hub
Once the adaptor has been added (posted) and configured, it can be launched. 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
...
7. Change an Adaptor's State
Once an adaptor is added (step 1, above) it is in the "Posted" state. The adaptor moves between states as follows:
Adaptor States
| 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. |
6. Start the Adaptor - Connect to the Hub
...
| . |
...
7. Change an Adaptor's State
An adaptor state can be changed using the request:
...
See the YOUnite API documentation (https://younite.us/api) for more requests that can be made to the adaptors endpoint.
A few common requests include:
...
Get Credentials for an Adaptor
By default only the zone data steward Zone Data Steward can retrieve the credentials for an adaptor:
...