Part 3. Modules
3.13 Reporting
The standard reports each part of Kestrel offers, the dashboard for your role, last night's findings, and asking the record a question in your own words.
Written forRegistrarFront officeTeacherHead of house or yearWellbeingLearning supportChild safety officerNursePrincipal and executiveBusiness managerIT
What it is for
Reporting is where you read the school's record as figures and lists. Each other part of Kestrel registers the reports it owns, such as the student roll or the staff compliance register, and Reporting gathers them in one library. It also contains the dashboard for each role, the overnight findings that tell the office who needs attention this morning, and a way to ask a question of the record in plain words.
Reporting reads the record at your own access. A column above your tier is not in the table and not in the file you download, and a finding above your tier is shown as a count.
Who uses it
| Role | What they can do |
|---|---|
| Registrar, front office, head of house, wellbeing | Run standard reports, open a dashboard, read the overnight findings and close them. |
| Principal | Run standard reports, arrange a dashboard, read and close findings, and ask the record a question. |
| Business manager | Run standard reports, arrange a dashboard and ask the record a question. |
| Learning support, child safety officer, nurse | Open a dashboard, read the overnight findings and close them. |
| Teacher | Open a dashboard. |
| IT | Run standard reports, open a dashboard and manage webhooks. |
In plain words, the capabilities are: running a standard report (reporting.library.run), opening a dashboard (reporting.dashboard.read), arranging one (reporting.dashboard.write), reading the overnight findings (reporting.finding.read), closing one (reporting.finding.resolve), asking the record a question (reporting.question.ask) and managing webhooks (reporting.subscription.manage).
Key ideas
- Standard report
- A report a part of Kestrel registered. It says what a row is and what it asks for, such as a day or a span of days.
- As at
- The moment a report is read for: now, or a day you choose. Running a report as at a past day shows the record as it stood then.
- Run
- One reading of a report. It has a record count and a checksum, so the file you download is the table you were shown.
- Dashboard
- The same reports with their parameters fixed for a role, as tiles. Each role has its own dashboard.
- Finding
- One line the overnight read raised about a student or a record that needs attention, with a pointer to the record behind it. A finding is Open until someone closes it with a reason.
- Ask the record
- A question typed in your own words and answered from the records you may read, with the rows shown beneath the answer.
Screens
Standard reports
/app/reportingThe reports you may run, grouped by the part of Kestrel that owns them, with what a row is and what each asks for.
Needs
reporting.library.runA standard report
/app/reporting/[key]Run one report with its parameters, read the table a page at a time, download it as CSV or PDF, and keep a run as a document.
Needs
reporting.library.runDashboards
/app/reporting/dashboardsThe dashboard for each of your roles, as of now.
Needs
reporting.dashboard.readFindings
/app/reporting/findingsWhat the overnight read found, worst first, with a chart by severity, the closed findings and the earlier nights.
Needs
reporting.finding.readAsk the record
/app/reporting/askType a question and read the answer with the rows behind it. Your recent questions are listed so you can open one again.
Needs
reporting.question.askQuality
/app/qualityWhat the test suites measured for the running build: coverage against its floors, mutation testing and how complex the code is.
Run a standard report
- Open Reporting and choose the report from the list. The list says what a row is and what the report asks for.
- Under "Run it", fill in what the report asks for, such as a day or a span, and choose "As at" if you want the record as it stood on another day.
- Choose "Run". The page says what the run found, then shows "The table" a page at a time.
- Choose "Download CSV" or "Download PDF" to take it away.
- To file the run on the record, open "Keep this report", choose the file to keep and choose "Keep this run".
Read and close the overnight findings
Each night Kestrel reads the record and raises what needs attention, such as a roll still open, a plan that is missing or an application waiting. The Findings page shows the latest night, worst first. A sentence counts the night by severity, a chart draws the same counts, and each line says what was found and points to the record behind it. The home page shows a panel of last night's findings too.
- Open Findings from the home page and read the night.
- Choose the pointer on a line to open the record behind it, and deal with it there.
- Close the finding and give the reason when you are asked "Why are you closing it?". Choose "Close finding".
A closed finding leaves the morning list and shows under "Closed findings" with who closed it, when and why. A later night that raises the same thing again opens a new finding. "Earlier nights" lists what each night before read. A source that could not be checked is counted on that night.
Ask the record
- Open Reporting, then "Ask the record".
- Under "Your question", type the question in your own words and choose "Ask".
- Read the answer under "The answer". Each read is shown with the rows you were shown, and you can show the rest of a long list.
- To ask again, open a question from "Your recent questions".
The answer is built only from the rows your own access reaches. If the school has not turned on "Ask the record", the page tells you so and names the setting an administrator turns on.
Tasks
- Run a standard report and download it.
- Run a report as at an earlier day.
- Open your dashboard.
- Read last night's findings and close one with a reason.
- Ask the record a question.
- Arrange the dashboard a role reads.
Journeys
Reporting is the last step of an assessment cycle, where a registrar runs the reports a school sends out. It also shows the morning message's findings in a day's rolls.
Settings
Three Settings screens belong to Reporting, and each is for an administrator. "Dashboards" arranges the dashboard each role reads: choose the dashboard, name it and load the current arrangement to change it. "Ask the record" turns on question answering, with the provider and the region the school names. "Webhooks" names the addresses told each time a kind of record changes. A delivery says which record changed and never what is in it, and the page lists the deliveries newest first.
Training notes
- Who needs it: each role needs its dashboard. The office and the heads of house need the library and the findings. The principal and the business manager need Ask the record.
- Suggested length: thirty minutes.
- Practise on the test school: run the student roll as at a day, download it, then close a finding with a reason.