Carrel Object List<\/p>\n
This was originally a google document developed collaboratively by project principals. This is still a work in progress and will evolve over time.
\nLibrary<\/p>\n
A library:<\/p>\n
* has many floors
\n* has an address, including latitude \/ longitude, URL and basic contact info
\n* has many reservable asset types
\n* has a bulletin board post expiration time<\/p>\n
Floor<\/p>\n
A floor:<\/p>\n
* belongs to a library
\n* has a map, most likely a high quality PNG
\n* is ordered relative to other floors – meaning a different floor is above or below it.
\n* has many call numbers
\n* has many subject areas.
\n* has many reservable assets<\/p>\n
Subject Area<\/p>\n
A subject area:<\/p>\n
* has and belongs to many floors
\n* has many call numbers
\n* has basic attributes like description and name<\/p>\n
Call number<\/p>\n
A call number:<\/p>\n
* belongs to a subject area
\n* has and belongs to many floors
\n* has a code, description and other basic attributes<\/p>\n
Reservable Asset<\/p>\n
A reservable asset:<\/p>\n
* belongs to a floor
\n* belongs to a reservable asset type
\n* has a location on the floor map – most likely an x y pixel offset to place it in the proper place.
\n* has many reservations
\n* has many users through its reservations
\n* has a section and number
\n* has a bulletin board
\n* has current users
\n* has a photo (optional)
\n* has a video (optional)
\n* has a minimum reservation time
\n* has a maximum reservation time
\n* has a reservation time increment – can only reserve in – say, 1 day or 1 week chunks.
\n* has a maximum number of concurrent users
\n* has a locker key \/ code (if defined in the reservable asset type)
\n* has general information, that\u2019s probably merged into the welcome message.
\n* can be relinquished by the user reserving it, returning a slot to the reservable pool.<\/p>\n
Reservable Asset Type<\/p>\n
A reservable asset type:<\/p>\n
* belongs to a Library
\n* has many reservable assets
\n* Has a name – carrel, locker, hold shelf, etc.
\n* Sets defaults for reservable assets – minimum reservation time, maximum reservation time, maximum number of concurrent users, reservation time increment, whether or not it has a code \/ key,
\n* Has options that effect the bulletin board – can have one? How long should posts live?
\n* has a photo
\n* has a welcome message, which may include follow-up instructions (Pick up your carrel reservation card here)
\n* has an expiration extension time period: the time before the expiration in which a user can renew a reservation for up to the maximum reservation time.
\n* has user types that can reserve this asset.
\n* has many Reservation Expiration Notices, which define the content and scheduling of reservation expiration messages. These messages can be related to either when an active reservation expires, or when a \u201creservation hold\u201d is expiration. A reservation hold is a reservation that hasn\u2019t been approved by a moderator.
\n* has a moderation flag – meaning, either the reservation goes through automatically without administrator approval OR an asset reservation must be OK\u2019d by an admin.
\n* has a \u201cmoderation held\u201d message. The welcome message can serve as the moderation approved message.<\/p>\n
Reservation Expiration Notices<\/p>\n
A reservation expiration notice:<\/p>\n
* has a type – \u201chold\u201d or \u201cactual,\u201d where \u201chold\u201d is a notice for the reservation hold expiration times, and \u201cactual\u201d is a notice for when an actively reserved item is expiring.
\n* belongs to a reservable asset type.
\n* has a \u201cdays before expiration\u201d attribute, which sets when this message is sent.
\n* has a message and a subject line
\n* has a reply-to
\n* is a multipart text\/html message
\n* will template tags to substitute simple parameter like Library name, user name, date, etc.
\n* belongs to many reservations, but is only invoked when the \u201cdays before expiration\u201d time is hit.<\/p>\n
Reservation<\/p>\n
A reservation:<\/p>\n
* belongs to a reservable asset
\n* belongs to a user
\n* has a code to uniquely identify it
\n* has a start date
\n* has an end date
\n* has an approved flag, which means the reservation has been approved by an administrator.<\/p>\n
Bulletin Board<\/p>\n
A bulletin board:<\/p>\n
* has many posts ordered by creation time
\n* belongs to a discussable asset – currently only a reservable asset, but could include a library.
\n* has many users through the reservable assets list of current users
\n* has a maximum \u201cpost lifetime\u201d<\/p>\n
Post<\/p>\n
A post:<\/p>\n
* belongs to a bulletin board
\n* belongs to a user
\n* has a creation time
\n* has a message
\n* has an (optional) image file attachment
\n* has many (optional) moderator flags
\n* has a \u201cpublic\u201d flag, allowing a post to be seen more broadly.<\/p>\n
Moderator Flag<\/p>\n
A moderator flag:<\/p>\n
* belongs to a post
\n* has a reason – Abusive, Offensive, etc?
\n* belongs to user<\/p>\n
Authentication source<\/p>\n
An authentication source:<\/p>\n
* has many users
\n* has many user types
\n* has an \u201cauthenticate\u201d method that accepts user information and does a backend lookup returning a true or false if a user has authenticated properly to that user type.<\/p>\n
User Type<\/p>\n
A user type:<\/p>\n
* has many users
\n* has a name – \u201cgrad students\u201d, \u201cundergrads\u201d, etc.
\n* has many authentication sources<\/p>\n
User<\/p>\n
A user:<\/p>\n
* has many reservations
\n* has many reservable assets through reservations
\n* has many posts
\n* belongs to a User Type
\n* has an authentication source through its user type<\/p>\n
Administrator<\/p>\n
An administrator:<\/p>\n
* Has a username and password.
\n* has an email address<\/p>\n","protected":false},"excerpt":{"rendered":"
Carrel Object List This was originally a google document developed collaboratively by project principals. This is still a work in progress and will evolve over time. Library A library: * has many floors * has an address, including latitude \/ longitude, URL and basic contact info * has many reservable asset types * has a […]<\/p>\n","protected":false},"author":4453,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-5","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/posts\/5","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/users\/4453"}],"replies":[{"embeddable":true,"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/comments?post=5"}],"version-history":[{"count":3,"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/posts\/5\/revisions"}],"predecessor-version":[{"id":19,"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/posts\/5\/revisions\/19"}],"wp:attachment":[{"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/media?parent=5"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/categories?post=5"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/archive.blogs.harvard.edu\/cmcgrath\/wp-json\/wp\/v2\/tags?post=5"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}