Skip to content
SoftSys Edu Analytics

Quick start

This guide takes you from zero to seeing your first event in the dashboard in under 30 minutes. If you already installed the plugin and have your credentials, skip straight to step 3.

Prerequisites

Section titled “Prerequisites”
  • Moodle 4.1 or higher with administrator access.
  • HTTPS egress from your Moodle server to ingest.softsysanalytics.com and api.softsysanalytics.com.
  • Tenant credentials provided by SoftSys Solutions (tenant ID + API key).

Step by step

Section titled “Step by step”

  1. Request your access and credentials

    Contact the SoftSys Solutions team to request tenant provisioning. You will receive:

    • Tenant ID — a unique UUID for your organization.
    • API key — formatted as ssea_ followed by 32 hexadecimal characters.
    • Recommended endpoints:
      • Ingest: https://ingest.softsysanalytics.com
      • API: https://api.softsysanalytics.com
      • Dashboard: https://app.softsysanalytics.com

    Store the API key safely — it cannot be recovered later (only revoked and reissued).

  2. Install the Moodle plugin

    Download the latest local_ssea.zip from the release channel agreed with SoftSys Solutions.

    In Moodle, go to Site administration → Plugins → Install plugins and upload the ZIP.

    Follow the installation wizard until Moodle completes the database migration. See Moodle plugin for manual install or advanced options.

  3. Configure the plugin

    Go to Site administration → Plugins → Local plugins → SSEA Analytics and fill in the required fields:

    SettingValue
    EnabledYes
    Server URLhttps://ingest.softsysanalytics.com
    API keyyour key (starts with ssea_...)
    Tenant IDyour tenant UUID

    Leave Delivery mode on batch (recommended) and Batch size at the default 50. Save changes.

  4. Validate in 30 minutes

    Have one or two test users:

    • Sign in to Moodle.
    • Browse to a course.
    • Open a resource or complete an activity.

    In parallel:

    • Open the dashboard (https://app.softsysanalytics.com) with your credentials.
    • Go to the Overview page (/) — you should start seeing non-zero counters within a few minutes.
    • If you use the default batch mode, the first flush happens every 5 minutes. Be patient on the first sync.

  5. Explore the dashboard

    With the first events arriving, you can start walking through the sections:

    • Users (/users) — you will see active users appear.
    • Courses (/courses) — course list with initial metrics.
    • At-Risk (/at-risk) — still empty; populates once the detection worker has enough history (typically 24–48h).
    • Alerts (/alerts) — also starts filling up once there is sustained activity.

    See Dashboard tour for a full description of each page.

Something not working?

Section titled “Something not working?”

No events arriving

Check that the plugin is enabled, the API key is correct, and Moodle cron is running. See plugin troubleshooting.

401 error

Your API key was rejected. Verify it matches what SoftSys Solutions provided and contact support if it persists.

SSL error

Update the CA bundle on your Moodle server. See troubleshooting.

What’s next?

Section titled “What’s next?”

Once SSEA is receiving events:

  • Run the historical migration (optional): enable the SSEA: Migrate Moodle data scheduled task to sync the current state of users, courses, enrollments, and grades to the backend. Useful to pre-populate the dashboard with existing history.
  • Configure At-Risk thresholds from the dashboard (/settings) to tune the detector’s sensitivity to your institution’s student population.
  • Explore the API (/en/api/events/, /en/api/dashboard/) if you want to build your own integrations on top of tenant data.
  • Review plans (/en/plans/) to understand quotas and when to upgrade.
Section titled “Related”