Email templates
Edited under Settings, Notifications. All are plain text.
Nothing sends until an email connector is configured and enabled.
The list
Section titled “The list”| Key | Name | Trigger | Audience | Can disable |
|---|---|---|---|---|
repair.submitted | Repair received | Someone lodges a repair through the client portal | The person who lodged it | Yes |
repair.ready | Collection reminder | A technician presses Email client on a repair | The person who lodged it | Yes |
repair.ready.tutor | Ready for collection (tutor) | A repair is ready and the student has a tutor on file | The student’s tutor | Yes |
repair.readyForCollection.student | Ready for collection (student) | A repair is marked ready for collection | The student | Yes |
repair.readyForCollection.parent | Ready for collection (parent) | A student’s repair is marked ready for collection | The student’s parents and guardians | Yes |
repair.readyForCollection.staff | Ready for collection (staff) | A staff member’s repair is marked ready for collection | The staff member | Yes |
loan.dueSoon.student | Loan due soon (student) | The morning a loan device is due back within three days | The student | Yes |
loan.dueSoon.parent | Loan due soon (parent) | The morning a student’s loan device is due back within three days | The student’s parents and guardians | Yes |
loan.dueSoon.staff | Loan due soon (staff) | The morning a staff member’s loan device is due back within three days | The staff member | Yes |
loan.due.student | Loan due today (student) | The morning a loan device is due back | The student | Yes |
loan.due.parent | Loan due today (parent) | The morning a student’s loan device is due back | The student’s parents and guardians | Yes |
loan.due.staff | Loan due today (staff) | The morning a staff member’s loan device is due back | The staff member | Yes |
loan.overdue.student | Loan overdue (student) | The morning after a loan device was due back | The student | Yes |
loan.overdue.parent | Loan overdue (parent) | The morning after a student’s loan device was due back | The student’s parents and guardians | Yes |
loan.overdue.staff | Loan overdue (staff) | The morning after a staff member’s loan device was due back | The staff member | Yes |
ticket.acknowledged | Ticket received | A ticket is raised with somebody to send it to | The person who raised it | Yes |
ticket.reply | Ticket reply | The desk replies in public. Internal notes never send | The person who raised it | Yes |
ticket.closed | Ticket closed | A ticket is closed and the requester has an email address | The person who raised it | Yes |
purchase.receipt | Purchase receipt | A student buys something and a parent address is on file | The parent or guardian | No |
licence.expiring | Software contract renewal | A software contract approaches its term end | The configured software renewal recipients | Yes |
monitor.down | Monitor alert | A monitored service has been unreachable long enough to alert | Staff who can view monitors | Yes |
backup.failed | Backup failed | A scheduled backup does not complete | Staff who can manage backups | No |
parent.login | Parent sign-in link | A parent asks for a link to the parent portal | The parent who asked | No |
plan.changed | Plan changed | A licence is activated or removed and entitled modules change | Staff who can manage billing | No |
report.scheduled | Scheduled report | A scheduled report is delivered | Whoever the schedule names | Yes |
digest.daily | Daily digest | Each morning, to staff who opted in | Staff with the digest turned on | Yes |
visitor.arrived | Visitor arrived | A visitor or contractor signs in to see somebody, and host notification is on | The staff member being visited | No |
visitor.wwccReminder | Contractor WWCC renewal | A contractor’s Working With Children Check is about to expire, or has | The visitor register’s reminder recipients | No |
Why six cannot be switched off
Section titled “Why six cannot be switched off”Four are mandatory because switching them off would hide something a person needs to know or act on:
purchase.receipt. A receipt to a parent for money taken. Switching it off
leaves you with no record when a parent queries a charge.
backup.failed. An alert about your own data protection failing. If it can
be switched off, eventually somebody will, and find out during a restore.
parent.login. The mechanism a parent uses to reach the portal. Off, the
portal has no entry.
plan.changed. Modules should not appear or disappear without explanation.
The two visitor register messages cannot be switched off here for a different reason: each already has its own switch. Host notification is turned off in the register’s settings, where the change is audited and every sign-in records it. WWCC reminders stop going by email when the register’s recipient list is empty. A second, unaudited switch in this editor would undo that.
Variables
Section titled “Variables”Written {{likeThis}}. The editor lists the ones each message carries, with a
description and a realistic sample.
Common ones:
| Variable | Holds |
|---|---|
{{name}} | Who the message is about or to |
{{deskName}} | What your service desk calls itself, from branding |
{{trackingUrl}} | The person’s private repair status link |
{{repairType}} | What kind of repair, when known |
{{deviceSuffix}} | The serial in brackets, or nothing when unknown |
{{loanLine}} | A line about the loan device, when one was issued |
A variable that does not exist on a message is rejected when you save, rather
than rendering blank in production. Otherwise a template containing
{{studentName}} on a message that never had a student would first show up in
what a parent receives.
Text rather than HTML
Section titled “Text rather than HTML”Every send in the product is plain text. An HTML editor would mean deciding how to escape a school’s own data inside it, and we have not made that decision.
Preview
Section titled “Preview”The editor renders your wording with sample values, so you see the message as a parent would. Wording that reads fine in the editor often reads oddly once the variables fill in.
What is worth changing
Section titled “What is worth changing”Ready for collection. Say where. “Ready to collect from the ICT office, opposite the library” saves a lot of questions.
Purchase receipt. Say what to do if something is wrong, and who to contact.
Repair received. Set a timing expectation if you have one.
Ticket received. Say whether replying to the email works. It does not by default.
What never sends
Section titled “What never sends”- Internal notes, ever.
- Anything with no recipient address on file, which is skipped without an error.
- Anything while the email connector is in demo mode, which logs instead.