Operational Process — Who Does What, When
This document describes how the platform is run within your organization. It focuses on roles and sequence, not screen operations.
If the Tutorial is about "trying it once by yourself for the first time," this document is about "running it continuously with multiple people." We have marked the points where responsibilities are divided and handoffs occur.
There Are Only Three Roles
| Role | Screen Label | Responsibilities |
|---|---|---|
| ADMIN | System Administrator | Accounts, security, equipment master, and all system settings |
| API | API Developer | Integration with external systems. API calls using tokens |
| USER | General User | Read-only. No change permissions |
It is not an option on the user registration screen, and the screen's save paths only accept ADMIN, API, and USER. Although MANAGER remains in the server's access control (e.g., for equipment command execution permissions), an account assigned this role has no post-login navigation branch, so it stops at the loading screen. For details, see Login.
If you need "partial permissions for a mid-level manager," do not use roles; use security policies (permission groups) instead → Security Management.
The visible menus differ by role → Login and Screen Layout.
Lifecycle — Three Phases
The overall flow, viewed as role-based lanes, looks like this. Arrows that cross lanes are handoff points.
1. Deployment and Commissioning — Once, But Done Right
| Step | Task | Owner | Deliverable |
|---|---|---|---|
| 1 | Installation | Deployment | Running platform → Installation |
| 2 | Replace all default passwords | Deployment | Handover document → Change initial password |
| 3 | Define ID rules | Deployment + Field | Naming rules document → Domain ID Rules |
| 4 | Register site → equipment → tags | Deployment | Equipment master |
| 5 | Edge connection and collection verification | Deployment | Values appear on the screen |
| 6 | Set alarm thresholds | Field | Alarm definitions → Alarm Management |
| 7 | Create accounts, assign roles | ADMIN | User list → User Management |
| 8 | Acceptance inspection | Field | Acceptance certificate |
IDs are embedded throughout the screens, APIs, and reports. A hastily chosen ID lingers for a long time. Write down the rules as a document before you start registering anything.
2. Normal Operation — Recurring Tasks
| Frequency | Task | Owner |
|---|---|---|
| Daily | Alarm check and response, check for collection interruptions | Field |
| Weekly | Check disk and resource trends → Monitoring | ADMIN |
| Monthly | Backup restoration rehearsal, account cleanup | ADMIN |
| Quarterly | Password rotation → Credential Rotation | ADMIN |
The most common failure is having backups that have never been restored. This is especially true with three storage locations → Database Model.
3. Changes and Expansion — When Equipment Is Added or Modified
| Task | Steps |
|---|---|
| Add equipment | Register master → tags → verify collection → alarms |
| Change tag meaning | First, verify that existing data and units won't be mixed |
| Add integration | Issue API account → token → IP restriction → API Manual |
If you change the meaning of a tag in use, past data and new data will be mixed under the same name. Reports cannot distinguish them. Create a new tag instead.
Handoff Points — Where Breakdowns Typically Happen
| Handoff | What to hand over |
|---|---|
| Deployment → Field | Account list, storage location for changed passwords, ID rules document, acceptance certificate |
| Field → System Administrator | Contact paths for incidents, how to generate diagnostic tarballs (./doctor.sh) |
| Personnel change | All of the above + Recent change history |
Document where they are stored. Transfer the values through a separate, secure secret management method.
Common Points of Misalignment
| Symptom | Typical Cause |
|---|---|
| "I don't know who changed this." | Sharing accounts — create an account per person |
| "Too many alarms, so nobody looks at them." | Thresholds set during deployment and never adjusted. Recalibrate each quarter |
| "The data is missing since [date]." | Collection interruptions not checked daily. Add this to daily inspections |
| "We received the handover but don't know the passwords." | The handover document lacks a storage location |