Student Status Management¶
Applies to: all staff who work with students; changing a status needs Students.Edit, deleting needs Students.Delete. Last reviewed: 2026-11-18.
Every student has one status that shows where they are in their journey from registration to licence. This page lists the statuses, explains how each one is reached, what each one allows or blocks, and how to license, deactivate, reactivate and delete a student.
1. Key point: statuses mostly change by themselves¶
There is no change-status drop-down
Staff cannot pick a status. A student's status changes as a side effect of other actions: booking a lesson, completing lessons, booking and recording tests, starting a course, and the specific menu actions Complete Training, License Student, Deactivate Student and Activate Student.
2. The statuses¶
The names are shown as below in the Student Directory and its status filter. The profile header shows them without spaces (for example "InTraining").
| Status | Colour in the directory | Meaning |
|---|---|---|
| Registered | Blue | Registered, no valid learner's licence recorded, no lessons booked yet. |
| On Hold | Orange | Exists in the list but nothing in the system sets it (see section 8). |
| Learners Pending | Orange | A learner's test is booked and the student has not started lessons. |
| Learners Passed | Teal | The student has a valid learner's licence (recorded at registration or on edit, or a learner's test was passed) and has not started lessons. |
| Learners Failed | Red | The student failed a learner's test and has not started lessons. |
| In Training | Green | The student has lessons booked or under way. |
| Training Completed | Teal | All lessons are done, or a staff member marked the training complete. |
| Ready For Test | Orange | A driving licence test has been booked. |
| Test Booked | Blue | Exists in the list but nothing in the system sets it (see section 8). |
| Test Passed | Green | The student passed the driving licence test. |
| Test Failed | Red | The student failed the driving licence test. |
| Licensed | Purple | The student has been licensed; the record is closed for editing. |
| Inactive | Dark | The student was deactivated by staff. |
3. How a status changes¶
flowchart TD
REG[Register Student] -->|no valid learner's licence| R[Registered]
REG -->|valid learner's licence| LP[Learners Passed]
R -->|book learner's test| LPE[Learners Pending]
LPE -->|pass| LP
LPE -->|fail| LF[Learners Failed]
LF -->|book learner's test again| LPE
R -->|first lesson booked| IT[In Training]
LP -->|first lesson booked| IT
IT -->|"all lessons completed, or 'Complete Training'"| TC[Training Completed]
TC -->|book driving licence test| RFT[Ready For Test]
RFT -->|pass| TP[Test Passed]
RFT -->|fail| TF[Test Failed]
TF -->|book driving test again| RFT
TP -->|"'License Student'"| L[Licensed]
The table below lists every trigger, including those the diagram leaves out.
3.1 Every trigger¶
| Action | Who / where | Status before | Status after |
|---|---|---|---|
| Register a student with a learner's licence that has an expiry date of today or later | Registration | (new) | Learners Passed |
| Register a student otherwise | Registration | (new) | Registered |
| Book a learner's test | Test booking | Registered or Learners Failed | Learners Pending |
| Book a learner's test | Any other allowed status (for example In Training) | Unchanged | |
| Record a learner's test result | Registered, Learners Pending or Learners Failed | Learners Passed (pass) or Learners Failed (fail) | |
| Record a learner's test result | Any other status (for example In Training) | Unchanged. The Has Learners Licence tick is still updated. | |
| Book a lesson, or approve a student's lesson request | Scheduling lessons | Registered, Learners Pending or Learners Passed | In Training |
| Complete a lesson (staff) or sign off a lesson, when it is the last lesson of the allowance | In Training | Training Completed | |
| Complete Training button | Profile > Lessons tab | Any status before Ready For Test (button rule) | Training Completed |
| Book a driving licence test | Test booking | Learners Passed, Training Completed or Test Failed | Ready For Test |
| Record a driving licence test result | Any | Test Passed (pass) or Test Failed (fail) | |
| License Student | Actions menu | Test Passed or Learners Passed | Licensed |
| Start New Course with a new package | Actions menu | Any (menu hidden for Licensed and Inactive) | In Training |
| Start New Course with an already purchased course | Actions menu | Training Completed, Ready For Test, Test Booked, Test Failed, Test Passed or Licensed | In Training |
| Start New Course with a purchased course | Any other status | Unchanged | |
| Edit a student who has a learner's licence with an expiry of today or later | Update Student page | Any except Inactive and Licensed | Learners Passed |
| Deactivate Student | Actions menu | Any except In Training, Ready For Test, Test Booked | Inactive |
| Activate Student | Actions menu | Inactive | Registered |
"Last lesson of the allowance" means the number of completed lessons has reached the package lessons plus extra lessons of the student's active course, and the package has at least one lesson. See Package allocation.
Completing a course (Complete Course / Complete Active Course) does not change the student's status. See Courses.
4. What each status allows and blocks¶
| Status | Book a lesson | Book learner's test | Book driving test | Record a payment | Edit student | Upload document | Add extra lesson |
|---|---|---|---|---|---|---|---|
| Registered | Yes | Yes | No | Yes | Yes | Yes | Yes |
| On Hold | No | No | No | Yes | Yes | Yes | Yes |
| Learners Pending | Yes | Yes | No | Yes | Yes | Yes | Yes |
| Learners Passed | Yes | Yes* | Yes | Yes | Yes | Yes | Yes |
| Learners Failed | Yes | Yes | No | Yes | Yes | Yes | Yes |
| In Training | Yes | Yes | No | Yes | Yes | Yes | Yes |
| Training Completed | Extra lessons only | Yes | Yes | Yes | Yes | Yes | Yes |
| Ready For Test | Extra lessons only | Yes | No | Yes | Yes | Yes | Yes |
| Test Booked | Extra lessons only | Yes | No | Yes | Yes | Yes | Yes |
| Test Passed | No | Yes | No | Yes | Yes | Yes | Yes |
| Test Failed | Extra lessons only | Yes | Yes | Yes | Yes | Yes | Yes |
| Licensed | No | No | No | No | No | Yes | Yes |
| Inactive | No | No | No | No | No | No | No |
* A learner's test can never be booked for a student who already has Has Learners Licence ticked, whatever the status.
Other rules that apply on top of the status:
- Lessons also need a valid learner's licence or a booked learner's test, and lessons left in the allowance. See Student training information and Package allocation.
- "Extra lessons only": once training is completed, a lesson can only be booked against an extra lesson added after the completion, until a new course is started.
- A driving licence test also needs Has Learners Licence ticked, and the student must not already have a test booked.
- Only one test can be booked at a time: "Student already has a scheduled driving test."
Messages when a status blocks an action:
| Message | Action blocked |
|---|---|
| Student is in status (status) and cannot book lessons. | Booking a lesson |
| This student has completed their training. Add an extra lesson, or start a new course, before scheduling another lesson. | Booking a lesson after training is completed |
| Student is (status) and cannot book a learner's test. | Booking a learner's test (On Hold, Inactive, Licensed) |
| Student is not eligible to book a driving test. | Booking a driving licence test |
| An inactive student cannot be edited. Reactivate the student first. | Editing (shown on screen only as "Unable to update student.") |
| Student has already Licensed | Editing a Licensed student |
| Documents cannot be uploaded for an inactive student. | Uploading a document |
| This student is inactive. Reactivate them before adding lessons. | Adding an extra lesson |
5. Licensing a student¶
Licensing closes the student's record once they have their licence.
Who: users with Students.Edit.
When it is offered: the License Student menu item appears only when the status is Test Passed or Learners Passed.
Steps¶
- Open the student's three-dot actions menu and click License Student.
- In the License Student box:
- Graduation Date (required) - starts on today.
- Graduation Notes (optional).
- Click License Student.
- You see "Student Licensed successfully." and the status becomes Licensed.
Screenshot to be added
Screen: License Student box. Should show: Graduation Date, Graduation Notes and the warning text.
Rules¶
| Rule | Message |
|---|---|
| The student must be Test Passed or Learners Passed. | Student is not eligible for licensing. |
| The student must not already be Licensed. | Student has already obtained licensing. |
| The student must have no outstanding balance on invoices that are Pending, Partially Paid or Overdue. | Student cannot License with an outstanding balance of (amount). |
| A date must be chosen. | Please select a graduation date. |
What licensing does and does not do¶
- It sets the status to Licensed and stores the date and notes.
- A Licensed student cannot be edited, cannot book lessons or tests, and payments cannot be recorded against them.
- The box says "Graduating the student will close their active course". It does not. The active course stays Active until someone completes it (see Courses). Do that before licensing, because Complete Active Course is hidden for Licensed students in the actions menu (it remains available on the profile's Courses tab).
- Lessons, tests, invoices and payments remain on the profile.
- There is no "undo". The only way a Licensed student's status changes again is by starting a purchased course for them through the API; the web menu hides Start New Course for Licensed students.
Licensing cannot be undone
There is no undo for licensing. Because Learners Passed also qualifies, a student who has only a learner's licence can be licensed. Check the status before confirming, and complete the active course first.
6. Deactivating and reactivating¶
Deactivating is how you take a student out of day-to-day use without deleting them. DriveFlow has no separate "archive".
Who: users with Students.Edit.
Deactivate¶
- Actions menu > Deactivate Student.
- Confirm: "Are you sure you want to deactivate this student?" > Deactivate.
- You see "Student deactivated successfully." The status becomes Inactive.
A student who is In Training, Ready For Test or Test Booked cannot be deactivated. The server's reason is "A student with status '(status)' cannot be set to 'Inactive'. Finish or cancel the training first.", but the page only shows "Unable to deactivate student." To deactivate such a student, first move them on: mark the training complete, or record the test result.
Effects of Inactive:
- The student stays in the Student Directory (filter by Inactive to list them) and counts in the Inactive card.
- They cannot be edited, booked for lessons or tests, given extra lessons, have documents uploaded or have payments recorded.
- Existing lessons are not cancelled automatically. Cancel any future lessons yourself.
- Their course stays as it was. Their portal sign-in is not switched off automatically; see Student portal.
Activate¶
- Actions menu > Activate Student (only shown for Inactive students).
- Confirm: "Are you sure you want to activate this student?" > Activate.
- You see "Student activated successfully."
The student always returns as Registered, whatever their status was before they were deactivated. The earlier status is not remembered. A student who was Training Completed, for example, comes back as Registered and will move to In Training again when the next lesson is booked. If they hold a valid learner's licence, opening Edit and saving will set them to Learners Passed.
7. Deleting a student¶
Who: users with Students.Delete (as seeded, the Owner and Administrator roles; the Owner always has every permission).
- Actions menu > Delete Student (shown in red).
- Confirm: "Are you sure you want to delete this student? The student will no longer appear in the active student list." > Delete.
- You see "Student deleted successfully."
What deleting does:
- The student is hidden, not erased (a soft delete). They disappear from the Student Directory and searches, and their profile can no longer be used.
- There is no check before deleting: a student with booked lessons, an active course or unpaid invoices can be deleted. Their lessons, invoices and payments stay in the database.
- There is no restore function in the application.
- The deleted student's identity number and email remain reserved: registering a new student with the same identity number or email is refused with "Identity Number already exists." or "Email address already exists."
Tip
For these reasons, prefer Deactivate Student unless the record was created by mistake.
Double prompt in the directory
When you delete from the Student Directory row menu, a second confirmation appears after the first delete has already happened: "Are you sure you want to delete (name) (student number)? This cannot be undone." If you click Delete again, the second attempt fails with "Failed to delete student." because the student is already deleted. The student was deleted by the first confirmation. Click Cancel on the second prompt. Deleting from the profile's bottom bar does not show the second prompt.
8. Limitations and notes¶
- On Hold is never set. No screen or automatic rule puts a student On Hold (
StudentStatus.OnHoldis only read, in the learner's-test and payment rules). The filter option exists but will normally return nothing. - Test Booked is never set. Booking a driving licence test sets Ready For Test, not Test Booked. The status exists in the filter and in a few rules only.
- No manual "Ready For Test". The server has an endpoint to mark a student Ready For Test (
PATCH api/Students/{id}/readyfortest) but no button calls it. - Editing can reset the status. Saving the Update Student page for a student with a valid learner's licence sets the status to Learners Passed, even if they were In Training, Training Completed, Ready For Test, Test Passed or Test Failed (
UpdateStudentCommandHandler.cs). Avoid editing such students unless needed, and check the status afterwards. The next lesson booking moves a Learners Passed student back to In Training. - Reactivation always gives Registered (
StudentsController.Activate). - Cancelling a driving test does not undo Ready For Test. The cancel rule only reverts a student from Test Booked, which is never set. A student left in Ready For Test after a cancelled test is not in the list of statuses that may book a driving test. This belongs to the driving tests documentation; it is noted here because it is a status effect.
- Complete Training has no server-side status check. The button is disabled for students at or beyond Ready For Test, but the endpoint itself would accept any status.
- Reasons are often hidden. Deactivate, activate, edit and delete show a general "Unable to ..." message; the specific reason from the server is not displayed.
- The comments typed in Complete Training are not saved.
- No status history. Status changes are not listed anywhere on the profile (the History tab is switched off).
- Licensing does not close the course, despite the wording in the box.
Related articles¶
- Student profiles - the actions menu and the status chip.
- Student training information - how the learner's licence affects the status.
- Courses - completing a course before licensing.
- Package allocation - training completed and extra lessons.
- Test results - recording test results.
- Student portal - portal access is separate from the status.