> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleverschool.systems/llms.txt
> Use this file to discover all available pages before exploring further.

# Pupil Portal

> Getting Started

> [!NOTE]
>
> Initial module enablement and manager assignment must be performed by an `Administrator`.

## Quick Start

Follow these five steps to enable and launch the Pupil Portal module for your school:

**1. Enable the Pupil Portal Module**

Navigate to **Administration** > **Modules** in the main navigation. Locate **Pupil Portal** (Pupil Area) and toggle the module to **Enabled**.

**2. Assign a Pupil Manager**

In **Administration** > **Staff**, assign the `Pupil Manager` role to designated leaders (such as the Assistant Head for Extracurricular, Heads of House, or Pastoral Leads).

> [!TIP]
>
> Until at least one `Pupil Manager` is assigned, administrators receive automated reminder notifications prompting them to delegate module management.

**3. Populate the Pupil Directory**

Ensure student records are imported into Cleverschool. Navigate to **Administration** > **Pupils** (`/admin/pupils`) to import pupils via CSV or trigger an automated **Wonde MIS Synchronisation**.

**4. Configure Student Authentication**

Determine how students will sign in—either using **Single Sign-On (SSO)** with Google Workspace / Microsoft 365 or via verified school email addresses and passwords.

**5. Verify Pupil Access via Impersonation**

In **Administration** > **Pupils**, locate a student record and select **Impersonate** from the row actions menu to verify that the student view loads correctly at `/pupil`.

***

## Further Setup (Manager Guide)

> [!NOTE]
>
> Operational maintenance, pupil directory administration, and role assignments are conducted by appointed `Pupil Managers` and `Administrators`.

### 1. Ingesting & Managing Pupil Data

Cleverschool provides two primary methods for establishing and maintaining student rosters:

* **Automated Wonde MIS Integration**:
  If your school connects to your Management Information System (such as SIMS, Arbor, Bromcom, or ScholarPack) through Wonde, pupil records—including forenames, surnames, year groups, forms, houses, sex, and profile avatars—synchronise automatically in the background.
* **Bulk CSV Import (`/admin/pupils/import`)**:
  Schools can upload pupil rosters using standard CSV spreadsheets. Cleverschool's intelligent import wizard allows you to map columns for `forename`, `surname`, `email`, `year`, `form`, `house`, and `sex`, updating existing pupil profiles without overwriting historical attendance records.

### 2. Setting Up Single Sign-On (SSO) & Email Verification

To ensure seamless student login without requiring pupils to remember separate passwords:

* **Google Workspace / Microsoft 365**: Enable OAuth provider integration so students can click **Sign in with Google** or **Sign in with Microsoft** on `/pupil/login`.
* **Email Verification**: When manual password registration is used, students receive an automated verification email with an activation link before accessing their dashboard.

### 3. Delegating Operational Roles

In **Administration** > **Staff**:

* **Pupil Owners (`pupils_own`)**: Assign pastoral leads, heads of year, and club coordinators who require operational access to review pupil attendance records and manage student engagement.
* **Pupil Viewers (`pupils_view`)**: Authorise governors, trustees, and administrative staff who require read-only visibility into extracurricular statistics and cohort engagement.

### 4. Linking Extracurricular Clubs & Meetings

To provide students with meaningful portal content:

* Ensure clubs and regular sessions are configured in the **Clubs & Fixtures** module.
* Enrol pupils into their respective clubs so upcoming meetings and fixtures appear automatically on their personal `/pupil` dashboard.
* Club leaders can project or print session QR codes at the start of each meeting for instant student check-in.

***

## Next Steps & Guides

> [card] [Tutorials & Walkthroughs](./tutorials)
>
> Practical walkthroughs for scanning QR check-ins, analysing house stats, and importing student records.

> [card] [Workflows & Lifecycle](./workflows)
>
> Deep dives into the student onboarding lifecycle, attendance processing, and pastoral interventions.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.