Skip to main content

Main overview

Upon successful login, the main screen is the home page that provides an overview of the realm status and resources.

Data Orchestrator Dashboard with a realm overview

API Status​

The API Status gives you general information about the status of services:

  • Realm Management is an administrator-like API for configuring a Realm. It is used for managing Interfaces and Triggers.

  • AppEngine is Data Orchestrator's main API endpoint for end-users. AppEngine exposes a RESTful API to retrieve and send data from/to devices, according to their interfaces. Every direct device interaction can be done from here. It also exposes Channels, a WebSocket-based solution for listening to device events in real-time with the same mechanism and semantics used by Triggers.

  • Pairing takes care of Device Authentication and Authorization. It interacts with Data Orchestrator's CA and orchestrates the way devices connect and interact with Transports. It also handles Device Registration. Agent, Device and Pairing interaction is described in detail here.

  • Flow is the API endpoint for Data Orchestrator Flow, used for managing Blocks, Pipelines, and Flows.

Possible statuses are:

  1. This service is operating normally.
  2. This service appears offline.

A general status on API health is also present in the app's sidebar, thus always providing a feedback regardless of which page you are currently visiting.

Realm resources​

Within the main overview, a brief summary is available as well for the existing resources of the realm: registered and connected devices, installed interfaces, and installed triggers.

More detailed overviews of each resource are available in the dedicated Dashboard sections, accessible via the navigation links in the Dashboard's side menu.