Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Initiates notification messages of relevant events and tasks. May use a variety of mechanisms internal to the CollectionSpace system, such as Dashboard items and pop-up windows, and mechanisms external to the system, such as email , and SMS text messages, and the like.

Note
titleBoilerplate structure and text below

Much of the page structure and text below this point is boilerplate, copied in from the relevant New Service template. Further work is needed to complete this page.

Assumptions

  • Try to be explicit and exhaustive, but not pedantic.
    • ~pschmitz@berkeley.edu: If there is an active discussion or comment, you may want to call it out as a sub-bullet. This example also uses a color macro to call it out, and provides a link to a given user to indicate that this is a particular contributor's position.

Subtopic

  • More assumptions around peripheral subject
    • Ex. An example of the case
  • Yet another assumption
    • Details of the assumption
      • Nitty-gritty detail 1
      • Nitty-gritty detail 2
  • Notification mechanisms may be real-time or asynchronous.
  • Multiple notification mechanisms may be used to send a single message.
  • Notifications can be sent to any "person in the system," or to any "referenced person," whose contact information corresponds to one or more supported notification mechanisms.

Key Concepts

  • Especially things that become common sense, and so usually missed by new reviewers

Dependencies

  • Note other services Services that are consumed by or that are closely related to this one include Contact, Person, and Organization.
  • To send automated notifications triggered by scheduled events or a monitored stream of system events, this service may also depend on Scheduler and Generic Eventing.

Background Documentation

  • If we have notes from community design meetings, link to them here.
  • If we have relevant sections in Spectrum or another such document, link to them here (or cite section numbers, etc.)