User guide
This guide walks through the DeviceChain web console, screen by screen, in the order the console's own navigation presents them. Each chapter explains what a screen is for, when you would use it, and what to expect, and is illustrated with screenshots of the console as shipped.
The guide is written for two audiences:
- Tenant users and administrators, who work with the devices, rules, alarms and dashboards of one tenant. Most chapters are for you.
- Instance operators, who administer the whole installation: tenants, tiers, identities and identity providers. Those screens are gathered in their own chapter.
New to DeviceChain? Start with Your First Device to get data flowing, then come back here to learn the console. For how the pieces fit together, see the Concepts section.
Chapters
Chapters are published as they are completed.
| # | Chapter | What it covers |
|---|---|---|
| 1 | Signing in | The sign-in steps, single sign-on, choosing a tenant, an expired session, and the user menu (theme, language, profile). |
| 2 | The console at a glance | The home page, the sidebar, the tenant chip, and what you see when an area is unavailable. |
| 3 | Devices | Listing, creating and importing devices; the device detail tabs, including assignment, connectivity and location, events, commands, configuration, credentials and replacement. |
| 4 | Device types and profiles | Device types and versioned device profiles: metrics, commands, configuration, and publishing or rolling back a version. |
| 5 | Detection rules | Authoring rules as a form, on the canvas, or in plain language; replay preview; rule health and the live feed. |
| 6 | Alarms | The live alarm list, filters, acknowledging and clearing. |
| 7 | Commanding a fleet | Command batches: creating one, following its progress, refusals and cancellation. |
| 8 | Dashboards | Templates and import, viewing, editing on the canvas, widgets and bindings, export, and version history. |
| 9 | Assets, customers and areas | The registry families: lists, hierarchy, property schemas and members. |
| 10 | Geofences | Drawing and editing fences, and their history. |
| 11 | Groups, facets and Browse | Facet keys, the Browse query builder, and saving a result as a dynamic group. |
| 12 | Connectors | Outbound connectors: creating, configuring and versioning them. |
| 13 | Audit | The tenant audit journal, filters and export. |
| 14 | Tenant settings | Branding, map and language. |
| 15 | Administering the instance | Tenants, deletions, tiers, identities, roles, identity providers, AI providers, instance audit and settings. |
| 16 | Updates (over the air) | Coming later. The console for firmware and software updates has not shipped yet. |
| 17 | Viewing dashboards in /dash | The read-only dashboard viewer: signing in and loading a dashboard by token. |