A client interface is any external program that accesses instance databases through the catalog API. Clients obtain DB role credentials from the host's catalog and connect to instances to perform their function.
Not to be confused with users or devices. A client is a service/driver/script, not a person or an IoT endpoint.
| Type | Description |
|---|---|
SERVICE |
Standard service (JSON-RPC, ArcView, MQTT) |
PREDEFINED_SERVICE |
Customer-predefined service |
CUSTOM |
User-defined client |
Each client has a clientApiKey valid across all nodes. This key authenticates the client to the catalog API on any host.
Manuals provide documentation to end users about how to connect and use a client's service. Visible in the Instance Manager.
A manual is a database record. Manual files include the actual uploaded files stored in DBM.
DETAIL_MANAGER)HOST_ROLE_MANAGER)See Admin Permissions for required rights.