Rothamsted-Ecoinformatics / farm_rothamsted

Custom farmOS features for Rothamsted Research.
GNU General Public License v2.0
6 stars 1 forks source link

E-mail Alerts: Alerts for Edited Research Entities, Assets and Logs #605

Closed aislinnpearson closed 6 months ago

aislinnpearson commented 9 months ago

Email alerts that capture edits on Research Entities, Assets and Logs

These e-mails do not have security and authenticity implications. They can be switched off/ you cannot opt out. Specifications and content of the e-mails in the attached.

E-mail Alerts - Alerts for edited Research Entities, Assets and Logs.pdf

Updated specifications, which includes logs and Farm Name

E-mail Alerts - Alerts for EDITED Research Entities, Assets and Logs.pdf

aislinnpearson commented 9 months ago

@paul121 - updated specifications added here as well (see description above)

aislinnpearson commented 7 months ago

Following our call today we agreed @paul121 would start with what is possible, I'll test it in a test instance and we can go from there.

paul121 commented 7 months ago

Yes - in this first pass I've modified the existing updated emails to be similar to the new email alerts as recently changed in #627 . Aside small differences like "new/updated" the main difference is that the updated emails will include a list of the field names that were updated (but not include the field values).

aislinnpearson commented 7 months ago

This looks great. I found a few typos and word changes, which I will add to go out in this release.

aislinnpearson commented 7 months ago

LOGS

A few minor changes (marked in red):

Visualised changes:

image

Currently renders like this:

image

aislinnpearson commented 7 months ago

RESEARCHERS

A few minor changes (marked in red):

Visualised changes:

image

Currently renders like this:

image

aislinnpearson commented 7 months ago

RESEARCH PROGRAMS

A few minor changes, all the same changes as requested for Researchers above.

Visualised changes:

image

Currently rendering as:

image

aislinnpearson commented 7 months ago

PROPOSALS

A few minor changes, all the same as for Researchers above with one slight variation on point 3:

Visualised changes:

image

Currently rendering as:

image

aislinnpearson commented 7 months ago

EXPERIMENTS

A few minor changes: In addition to the changes described for Experiments above, please can we:

Visualised changes: image

Currently rendering as: image

aislinnpearson commented 7 months ago

DESIGNS

In addition to the changes described for Experiments above, please can we make the following changes (note these are the same for the Experiments, but for Designs):

Visualised changes:

image

Currently rendering as:

image

aislinnpearson commented 7 months ago

PLANS

Similarly for the changes described for Experiments and Designs above, please can we make the following changes:

Visualised Changes: image

Currently rendering as: image

aislinnpearson commented 7 months ago

Hi @paul121,

All the minor comments as promised... although I just noticed I haven't always capitalised the entity name. Would you mind checking for that as well? Sorry - it would take me ages to check the screen grabs, although I have done it in the document attached below.

As an aside, I noticed that when you add an experiment boundary, you only get a notification to say that a location has been added. Similarly, when you upload your variables or geoJSON you only get a notification to say that you have added files. Is there a nice way we can change the alert so that these specific actions generate a more specific message in the e-mail somewhere? Happy to chat this through if needed.

Here is the actual word document as a PDF: E-mail Alerts - Alerts for EDITED Research Entities, Assets and Logs.pdf

paul121 commented 6 months ago

although I just noticed I haven't always capitalised the entity name. Would you mind checking for that as well?

Done! I found a few, hopefully all of them.

Is there a nice way we can change the alert so that these specific actions generate a more specific message in the e-mail somewhere? Happy to chat this through if needed.

There are some ways we could do this, but lets open a new issue to track it. It wouldn't be very complicated to just add additional text into this existing email when that is the case.