Skip to content

D. Actions

Matthew Campbell edited this page Jan 22, 2017 · 18 revisions

Services or actions as they are called in this project determine what can be done with things by the caller of this library. Services are grouped from the perspective of the end-user.

#Caretaker# A caretaker is the legal guardian of a child registered at a daycare. Only daycare staff can issue access to Prenotes. Once the caretaker has confirmed their email then they can notify, reply to notifications, retract notifications, mark notifications as read and pull notifications as a stream. They can also edit their name, see which children they are associated with and even nuke their account.

##Confirmation## Daycare staff issue a confirmation code to caretakers. The expectation is that staff receive a caretaker's email address and then through Prenotes dole out a confirmation email. At least one child registered to the daycare must be associated to the caretaker in the confirmation step (i.e. the handshake). A caretaker registers for Prenotes by giving the confirmation code they will find in an automatic email sent out by Prenotes. During registration the caretaker could be asked to supply their name. Prenotes will not retain anything other than the caretaker's name in their profile. A caretaker may nuke their account. This will completely remove the caretaker from Prenotes except for notifications they have created. Nuking an account does not remove children from Prenotes. A caretaker must ask daycare staff to remove children from Prenotes.

##Streaming## Prenotes streams notifications to the end-user. There is no search function. The idea is that notifications surface in an infinite scroll by order of creation time in descending order (i.e. the newest first). The ability to search might be added later. Prenotes acts like a fire hose giving the user the latest notifications upfront. A caretaker can create a notification by providing a message and the children related to the message. At least one child has to be related to a notification. Caretakers can retract a message they have created. This doesn't delete the message rather excludes it from being streamed. Caretakers can also reply to notifications streamed to them.

#Employee# Daycare staff are represented as employees in Prenotes. They are also users just like caretakers. The confirmation and streaming services allotted to caretakers are the same for employees. The administrator of the daycare or super user will issue a confirmation email to employees. The administrator for a daycare has special privileges. They can confirm and detach employees from the daycare. They also are only ones whom may create a guest employee to be used by substitutes or temporary staff. Employees may stream notifications for all children registered to the daycare.

##Kids## Only an employee of the daycare can register or take away a child. The child just like users will need a name which is treated as unique. To differentiate between children with the name a nickname must be assigned.

#Administrator# An administrator derives from an employee. It has special privileges to handshake employees, retract employees, create a guest employee per daycare and can grant administration rights to an employee. Any employee granted administration rights can act like an administrator except like can not pass on grants. An administrator can be active at one or more daycare sites. Administrators may stream notifications for all children registered to daycare sites they administrate.

#Super# Every instance of Prenotes has one or more super users. A super user will create or retract daycare sites. When a daycare is created at least on administrator has to be associated with the site. There is a special function to send out a confirmation to super users which is meant to be done at start up or restart. Super users may stream all notifications from any daycare site.

Clone this wiki locally