Academic Setup — Demo & Onboarding Guide
From curriculum to report card: what an institution administrator sets up, what a teacher does with it, and how every result is calculated. All numbers below are sample data for a walkthrough.
1. The big picture
Six stages. Blue = administrator, green = teacher, dashed = the system calculates, violet = student/guardian sees it.
Three kinds of “term” — do not mix them up
| Name in the app | What it is for | Where it is set |
|---|---|---|
| Academic period | The school year. Everything hangs off it. | Settings › Academic Periods (platform administrator) |
| Timetable terms | Calendar blocks for the timetable (Semester 1, Semester 2). | Timetable Terms |
| Grading terms | The terms marks are recorded against. Each has a weight. These drive results. | Assessment › Assessments |
| Curriculum terms | Chapters of the curriculum: which outcomes are taught when. | Curriculum › Curriculum Setup |
2. The sample school used in this guide
School
| Institution | HidayatUnNisa |
| School year | 2026–2027 |
| Grade / class | ALIM Year 1 / class ALIMGY1C1 |
| Student followed | Zainab Idris |
| Pass mark | 50% |
Subjects and grading terms
| Subject | Lessons / week | Teacher |
|---|---|---|
| Arabic | 5 | Ustadh Bilal |
| Urdu | 3 | Ustadha Amina |
| Health | 2 | Ms Clara |
Grading terms: Term 1 weight 40, Term 2 weight 60.
3. Curriculum template and outcomes Administrator
In this app a curriculum template and an outcome template are the same record: one template per grade and school year, holding the terms and the learning outcomes a student must reach.
- Open Curriculum › Curriculum Onboarding. Pick the institution and school year, then press Start.
- Foundation step: enter code
ALIMY1-2026, a name, the grade, and at least one outcome. Press Save Template. Repeat per grade. - To add terms or more outcomes later, open Curriculum › Curriculum Setup and select the template.
- The wizard then walks you through Offerings, Staffing and Delivery — the assignments in section 4. Section 5 then turns them into a timetable and calendar.
4. Assignments Administrator
“Assignment” means four different things in the menus. This is how they connect:
| What you assign | Menu | Sample | |
|---|---|---|---|
| A | Subjects to a grade and its classes, with lessons per week | Classes › Subject Offerings | Arabic → ALIMGY1C1, 5 per week |
| B | Teachers to subjects | Classes › Curriculum Setup · Teachers | Ustadh Bilal → Arabic |
| C | Lessons into the weekly timetable | Calendar › Timetable Builder | Mon–Fri 08:30 Arabic |
| D1 | Cover for an absent teacher, with a deadline | Curriculum › Cover Assignments | Ustadha Amina covers Mon 08:30 |
| D2 | Homework and graded home assignments for students | Curriculum › Homework | “Letter practice”, marked out of 20 |
One-stop alternative for A and B: University Setup walks grades → classes → subjects → teachers in one wizard.
5. Lesson planning: from curriculum to the calendar Administrator Teacher
New since November 2026: chapters with weights, a week-by-week plan, a lesson log per objective, weighted chapter progress and test scores with draft and published are described, with demo data, in the Teaching guide. The pages below (Lesson Planning, Teacher Coverage) are the older way and are now labelled “Lesson slots (Old planning)” and “Teacher Coverage (Old lesson log)” in the menu.
A lesson only reaches a student's calendar when four things exist: what is taught (the curriculum), who teaches it to which class and how often, when the school day runs, and a published timetable that places it. Lesson planning then says which outcome each lesson covers.
How the records hang together
The timetable is a weekly pattern. The calendar turns each slot into a dated lesson for every school day of the term, skipping weekends, holidays and closures. The outcome link sits on the slot, so it applies to every week that slot repeats.
Start here: the Academic Setup Checklist
One page tells you, for an institution and school year, which of the steps below are ready, which need a check and which are not started. Each step lists what is missing by name (for example “ALIMGY4C · Math — no teacher”) and has a button that opens the page that fixes it. The banner at the top always names the next step to do.
Academic Setup Checklist (School Calendar group; administrators and principals)
Steps checked: school-year dates · terms · grades offered · classes · curriculum · subjects and lessons per week · teachers · school day · holidays · timetables · published · lesson planning · data integrity.
Step by step, with the sample class
| # | Do this | Menu | Sample |
|---|---|---|---|
| 1 | Create the curriculum template and outcomes (section 3). | Curriculum Onboarding | ALIMY1-2026, AR-1.1, AR-1.2, UR-1.1 |
| 2 | Link each subject to the class and enter lessons per week. The timetable generator places exactly this many. | Curriculum Setup › Classes | Arabic 5, Urdu 3, Health 2 |
| 3 | Give each class-subject its teacher. The teacher is set per class, so a teacher only sees the classes they actually teach. | University Setup step 5 | Arabic → Ustadh Bilal |
| 4a | Make sure the term exists for this school year (Semester 1, Semester 2). Institution administrators and principals manage the terms of their own institution; a term must sit inside the academic period, and a term a timetable uses cannot be deleted. | Timetable Terms | Semester 1: 1 Sep – 21 Dec |
| 4b | Build the school day: periods with start and end times, plus breaks and lunch. Check school days (e.g. Mon–Fri) and apply the country's public holidays. | Calendar Setup | 10 periods from 08:30, lunch 12:00–12:45 |
| 5a | Create one timetable for the class and term, then Auto-generate. The dialog opens on a preview and lists every subject with its lessons per week; change a number there and it is saved for the class and the preview updates. To do all classes of a grade at once, use Generate whole grade (shared teachers are never double-booked; published timetables are skipped). Or place lessons by hand and drag them; only free cells accept a drop. | Timetable Builder | 10 of 10 lessons placed, spread over 5 days |
| 5b | Fix blocking conflicts (teacher or room booked twice, lesson on a break), then Publish. | Timetable Precheck | 0 blocking |
| 6 | Teacher opens the class and subject, picks the semester, and ticks which outcome each weekly slot covers. Click a cell to cycle Introduced → Reinforced → Mastered. | Lesson Planning | Mon P1 AR-1.1 I · Wed P1 AR-1.1 R · Fri P1 AR-1.2 I |
| 7 | Lessons appear on the calendar with subject, teacher and room. Lessons of a draft timetable are shown dashed and labelled Draft, and only administrators and principals see them. | School Calendar My Schedule My timetable | Mon 7 Sep 08:30 Arabic · Ustadh Bilal · Room 101 |
| 8 | After each lesson the teacher records what happened. This is the evidence used when a test is created. | Teacher Coverage | 7 Sep: Taught |
When does a slot become a calendar lesson?
- The date is inside the timetable's term.
- The weekday is a school day and the period runs that day.
- The date is not a public holiday or school closure.
- The period is a teaching period, not a break.
- Students, guardians and teachers only see published timetables.
- Only administrators and principals create, generate, copy or restore timetables and terms.
What the planner shows the teacher
- One row per weekly slot of the chosen semester, with its first date.
- Outcomes of the grade's template, grouped by curriculum term.
- Planned versus covered counts per outcome.
- “Mastered” is only allowed once the outcome is linked to an assessment.
6. Assessments Administrator Teacher
| Type | Typical use | Sample in Term 1 |
|---|---|---|
| Quiz | Short check, in class | Arabic letters quiz, 12 Oct |
| Unit test | End of a chapter | Arabic unit test, 5 Nov 09:30 |
| Assignment | Graded homework that counts | Letter practice, out of 20 |
| Exam | End of term | Term 1 exam, 15 Dec |
- Open Assessment › Assessments and press Create assessment.
- Choose the type, grade, class, subject, date and time. The app warns if the class already has a lesson or another test at that time.
- Marks are entered on the same page. A mark is always stored on a 0–100 scale.
- Who may create assessments is a per-institution choice: administrators only, teachers may add items, or teachers may create everything. Set it on the institution's edit page under Teacher permissions.
Graded home assignment
In Homework › Create Homework, tick Graded assignment and enter Marked out of. Tick Count the mark toward results and give it a weight (default 10) if it should affect the subject average. Students see “Graded · out of 20” before handing in. A mark of 17 out of 20 enters results as 85.
7. How results are calculated
Every mark counts with the weight of the term it belongs to. A graded home assignment counts with its own weight.
Worked example: Zainab, Arabic
| Mark | Belongs to | Mark (0–100) | Weight | Mark × weight |
|---|---|---|---|---|
| Term 1 exam | Term 1 | 70 | 40 | 2,800 |
| Term 2 exam | Term 2 | 85 | 60 | 5,100 |
| Letter practice 17/20 | Graded assignment | 85 | 10 | 850 |
| Total | 110 | 8,750 |
Arabic average = 8,750 ÷ 110 = 79.55%
All three subjects
| Subject | Term 1 (40) | Term 2 (60) | Homework (10) | Average | Result |
|---|---|---|---|---|---|
| Arabic | 70 | 85 | 85 | 79.55 | Pass |
| Urdu | 60 | 50 | — | 54.00 | Pass |
| Health | 45 | 65 | — | 57.00 | Pass |
Urdu: (60×40 + 50×60) ÷ 100 = 54. Health: (45×40 + 65×60) ÷ 100 = 57.
8. Setting up GPA Administrator
Menu: Assessment › GPA Configuration
Step 1 — sample GPA scale
| Band | Average from–to | Points |
|---|---|---|
| A | 80 – 100 | 4.00 |
| B | 70 – 79.99 | 3.00 |
| C | 60 – 69.99 | 2.00 |
| D | 50 – 59.99 | 1.00 |
| F | 0 – 49.99 | 0.00 |
Bands must not overlap and must cover 0 to 100. A subject whose average falls in no band is reported as unmapped.
Step 2 — policy choices
| Scope | One year and grade, or “All”. The most specific policy wins. |
| Weighting | Equal: every subject counts once. Credit: a subject counts by its lessons per week. |
| Decimals | 0 to 2 |
| Unmarked subjects | Leave out (default) or count as 0 points |
| Cumulative | None, previous grading terms, or previous grades |
No policy for a grade means no GPA is computed for it; the page says so.
Worked example: Zainab's GPA
| Subject | Average | Band | Points | Lessons / week | Points × lessons |
|---|---|---|---|---|---|
| Arabic | 79.55 | B | 3.00 | 5 | 15.00 |
| Urdu | 54.00 | D | 1.00 | 3 | 3.00 |
| Health | 57.00 | D | 1.00 | 2 | 2.00 |
| Total | 5.00 | 10 | 20.00 |
Equal weighting: 5.00 ÷ 3 subjects = GPA 1.67 · Credit weighting: 20.00 ÷ 10 lessons = GPA 2.00
Same marks, different GPA. Decide the weighting once per grade and tell teachers which one applies.
9. Report cards
Menus: Report Cards › Generate Report Cards › Review & Approval Report Cards Dashboard
Students and guardians only ever see released cards. Regenerating never resets an approved or released card.
10. Teacher guide Teacher
Teachers do not change the setup, but they can see everything that affects their classes. Start here after signing in.
| I want to see… | Teacher menu | What it shows |
|---|---|---|
| The curriculum and outcomes for my subject | Teaching › Programs | Outcomes by curriculum term, with planned and covered counts |
| Which outcomes each lesson covers | Teaching › Lesson Planning | Link outcomes to lessons: Introduced, Reinforced, Mastered |
| Tests scheduled for my classes, and mark entry | Teaching › Assessments | List, mark sheet, and a per-assessment report (averages, pass rate) |
| Homework and graded assignments | Teaching › Homework | Create, see submissions, grade with a capped numeric mark |
| Each student's average and rank | Teaching › My Students | Weighted average per student and per subject |
| Report cards for my class | Teaching › My Class Report Cards | Status, average, homeroom comment box |
Calculating a student's result by hand — four steps
- Convert every mark to a percentage. 17 out of 20 is 85.
- Multiply each percentage by the weight of its grading term (or the assignment's own weight) and add them up.
- Divide by the sum of the weights you used. That is the subject average. 50 or more is a pass.
- For GPA: look up each subject average in the band table to get points, then average the points (equal) or weight them by lessons per week (credit).
Your hand result should match My Students. If it does not, check that a mark was not entered under the wrong grading term.
11. Coaching a student to pass Teacher Student
The most useful thing to tell a student is a number: what they need in what is left.
Example: Health after Term 1
Term 1 mark 45 (weight 40). Term 2 (weight 60) still to come. Pass mark 50.
(50 × 100 − 45 × 40) ÷ 60 = 3,200 ÷ 60 = 53.3% needed in Term 2.
Zainab scored 65, so she finished on 57 and passed.
What to say, by situation
| Needed in remaining work | Message to the student | Action |
|---|---|---|
| Below 50% | “You are on track. Keep your routine.” | Aim for the next band; show the band table |
| 50–70% | “Passing is realistic with steady work.” | Pick the two weakest outcomes in Programs and practise them weekly |
| 70–100% | “You need a strong finish.” | Hand in every graded assignment (easy weight), agree a revision plan with the guardian |
| Above 100% | “A pass is not reachable by marks alone.” | Speak to the administrator early about a resit or extra graded work |
Where the biggest gain is: the term with the highest weight. In the sample, one extra point in Term 2 is worth 1.5 times a point in Term 1. Graded assignments are small but certain: they reward effort, not exam nerves.
Students check progress under My results and My learning; guardians under Results in the parent portal. Use Messages to send the target number to the family.
12. Demo checklist (about 35 minutes)
| # | Sign in as | Show | Say |
|---|---|---|---|
| 1 | Administrator | Curriculum Onboarding | One template per grade holds terms and outcomes |
| 2 | Administrator | Subject Offerings, then Teachers | Subjects to classes, teachers to subjects |
| 3 | Administrator | Assessments | Grading terms carry the weights; create one unit test |
| 3a | Administrator | Academic Setup Checklist | What is ready, what is missing, and the next step |
| 3b | Administrator | Timetable Builder | Auto-generate from lessons per week (edit them in the dialog), check conflicts, publish |
| 3c | Teacher | Lesson Planning | Link an outcome to Monday's slot: Introduced |
| 3d | Student | My timetable | The same lesson, dated, with teacher and room |
| 4 | Teacher | Homework | Graded assignment, out of 20, counts toward results |
| 5 | Teacher | Assessments › mark sheet | Enter two marks, open the report |
| 6 | Administrator | GPA Configuration | Scale, policy, Preview, then Compute |
| 7 | Administrator | Generate → Review & Approval | Nothing reaches families until release |
| 8 | Student | My results, My report cards | Same numbers the teacher saw |
Demo accounts for the sample institution are listed in docs/uat-seed-hidayatunnisa.md.