Docs / Manual
Administration
What an administrator does, and where: commands on the edge PC and a few Web UI functions.
In this release an administrator works mostly with commands on the edge PC and configuration files. In the Web UI, an administrator has every screen an expert has, plus Asset codes (PDF) and, where the site has turned it on, the Remote support panel in the top bar.
| Task | How | Page |
|---|---|---|
| Add and list user accounts | python -m edge.users add NAME ROLE, or POST /api/admin/users | Add a user |
| Sign-in through the site directory | config/directory.json | Accounts and sign-in |
| Export or erase a user's personal data | GET /api/admin/users/<name>/personal-data, POST /api/admin/users/<name>/erase | Personal data |
| Site configuration | site.yaml | Site configuration |
| Deployment profile | deploy/config/profile | Deployment profiles |
| Connectors | site.yaml endpoints, historian, cmms, and the Compose profiles | Data sources and connectors |
| Asset QR codes | Asset codes (PDF) in the top bar | Asset pages and QR codes |
| Updates and rollback | python -m settings.release install or rollback | Updates and decommissioning |
| Backup and restore | the backup service; python -m settings.backup --restore | Backup and restore |
| Integration accounts | python -m edge.api.integration add | Integration API |
| Licence | python -m settings.licence machine-id, install, show; the renewal notice in the top bar | Licence, Renew a licence |
| Remote support window | Remote support in the top bar, once config/remote_support.json exists | Remote support, Open a remote support window |
| Training mode | site.yaml training: true | Training mode |
| Document sources | site.yaml document_sources, page_cache, and the watch profile | Documents and work orders |
| Platform alarms | the red banner in the Web UI and /api/health | Troubleshooting |
Every sign-in, configuration change, profile change, import, licence status change and remote support window is written to the append-only audit log.
Planned. An Administration screen for users, site configuration, connectors, the licence, updates and backup (S10). Today these are the commands and files above; the remote support window is already opened from the Web UI.