User guide
This guide is for institutional administrators using the web console. Plan and retention details are in the FAQ. Settings in the dashboard links to this documentation site. There is no /faq route inside the app.
1. Access
Section titled “1. Access”- Google (recommended): sign in with the authorized account; the system associates a tenant (typically 1:1 with the email on first access unless configured otherwise).
- API key: from the login screen, “Admin / API Key” with Tenant ID and
ssea_…key (useful for service accounts or testing).
If you see no data, ensure the Moodle plugin local_ssea is enabled with correct URLs and API key (see Moodle connection).
2. Main navigation
Section titled “2. Main navigation”| Area | Purpose |
|---|---|
| Overview | KPIs, trends, and recent activity. |
| Courses / Users | Lists and participation detail. |
| Enrollment / Grades / Completion | Aggregated academic views. |
| At-risk | Rule-based supports; acknowledging alerts. |
| Alerts | History and acknowledgements. |
| Reports | Async jobs and generated reports. |
| Documentation | External link to this site (plans, retention, limits); details in FAQ. |
| Settings | Tenant ID, API and ingest URLs, copy credentials for Moodle. |
3. Plans, limits, and retention (summary)
Section titled “3. Plans, limits, and retention (summary)”- Daily event limits depend on the plan (Free, Starter, Pro, etc.).
- The Free plan applies rolling 30-day (UTC) retention to telemetry and derived data; it does not remove the synced Moodle catalog (users/courses/…) by itself.
Details: FAQ and, for internal implementation, DATA_RETENTION.md (repo).
4. Moodle connection
Section titled “4. Moodle connection”Under Settings you will find:
- Tenant ID (UUID)
- API URL → plugin
api_url - Ingest URL → plugin
server_url/ ingest - API Key → only if the session has one (e.g. key login); with Google-only you may need to generate a key in the platform admin and paste it into Moodle.
Plugin install and troubleshooting: MOODLE_PLUGIN.md (repo).
5. Reports
Section titled “5. Reports”Heavy reports are queued; the console shows status (queued, running, ready, error) and last update. On Free, old jobs and files may be removed when outside the retention window.
6. Moodle (plugin) views
Section titled “6. Moodle (plugin) views”Depending on Moodle permissions:
- Student: own reports (where the plugin exposes them).
- Teacher: course health and at-risk students they manage.
- Administrator (capability): aggregated views / links to the console as configured.
7. Support
Section titled “7. Support”- Product issues: channel agreed with SoftSys Solutions.
- Technical repo docs:
plan/.