Weekly email digest to user about case activity

[franck-boullier]

Overview:

In order to keep user informed about what's happening on all the units they have a role in, we need to send a 'weekly digest' to each user.

Key features:

• Digest is sent every Friday via email.
• Capability for a user to Opt out from this digest at any time.
• Capability for a user to Opt back in from this digest at any time (will NOT be part of the MVP).

What should be included in the digest:

The list of cases that the user is a party to which have been updated over the past 7 days.
A Case that a user is a party to is a case where the user is either:

• The case creator
• The case assignee
• In CC for the case

Suggestion to display the information:

We should group the cases by unit and make sure the following information are displayed:

• Name of the unit (from the MEFE)
• Address of the unit (from the MEFE)
• Link to the Unit summary in Unee-T (from the MEFE)
• Role of the user in the unit.
  Under each unit, we should list the following information
• Title of the case
• Clickable link to the case
• How many changes have been made to this case over the previous 7 day period (a number).

[franck-boullier]

@kaihendry as per our conversation about integration with mailchimp, this might come in handy: MailChimp API documentation.

[kaihendry]

Starting to think MEFE is the best place to implement this since it stores every message in Mongo.Collection('messagePayloads').

We also need to define a datastructure / UI in the user collection schema of a user makes the notification preference of weekly.

Guess mails going out on the start of the week would be good.

[franck-boullier]

MEFE is the best place to implement this since it stores every message in Mongo.Collection('messagePayloads')

Another alternative is to use the Built in native BZ REST API to query the history information for a given case.
If we compare:

• the case history information as of a given date and
• the current datetime,

We should be able to retrieve all the changes for any case.

We can then combine this with the list of case that a given is involved over the period covered by the digest and we'll get all we need to create that digest.

This has the benefit of getting the data directly from the source of truth for case related information instead of a secondary source for that...

More details on the native BZ REST API to retreive the history of a bug is available there: http://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#bug-history

Not sure about the performance of such a solution though...
@nbiton any comment on this idea?

[kaihendry]

Are there any designs related to this digest? Is it a reverse chronological summary of events? Perhaps its a report rather? Ultimately this needs to be something useful for property managers to structure their work and provides enough value they would want to hand over money for it.

A digest could ultimately be noise, a whole bunch of inconsequential updates with no content, where some sort of summary, like who the issue is assigned to and what's the current solution is often better.

[franck-boullier]

@kaihendry see an example of how it could be done here:
https://unee-t.slack.com/files/U6F3W137F/FBH4UFTQX/image.png