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

[aislinnpearson]

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]

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

[aislinnpearson]

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]

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]

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

[aislinnpearson]

LOGS

A few minor changes (marked in red):

• Please can we shorted/ amend the e-mail title to '[Farm Name]: Edited [Log Type]'
• Please can we edit 'changed values' to read 'The following data fields have been changed'
• Please can we include the revision message (or 'None' if there isn't one - see associated issue #565)
• Please can we edit 'please check the details are correct' so it reads 'please check the changes are correct'

Visualised changes:

Currently renders like this:

[aislinnpearson]

RESEARCHERS

A few minor changes (marked in red):

• Please can we edit 'changed values' to read 'The following data fields have been changed'
• Please can we include the revision message (or 'None' if there isn't one - see associated issue https://github.com/Rothamsted-Ecoinformatics/farm_rothamsted/issues/565)
• Please can we edit 'You will continue to receive updates about this Research Profile if it is edited by a Farm Manager or Farm Data Administrator' so it reads 'You will continue to receive e-mail updates about this Research Profile.'

Visualised changes:

Currently renders like this:

[aislinnpearson]

RESEARCH PROGRAMS

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

Visualised changes:

Currently rendering as:

[aislinnpearson]

PROPOSALS

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

• Please can we edit 'You will continue to receive updates about this Proposal' (already shorter than in the Researcher and Research Programs) so it reads 'You will continue to receive e-mail updates about this Research Profile.'

Visualised changes:

Currently rendering as:

[aislinnpearson]

EXPERIMENTS

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

• edit the title, changing it from '[Farm Name]: Update to your Research Experiment in farmOS' so it reads '[Farm Name]: Update to your Experiment in FarmOS'
• edit '[Name] has edited an Research Experiment you are associated with in FarmOS' so it reads '[Name] has edited an Experiment you are associated with in FarmOS. '.
• edit 'To view the Research Experiment please click the link below :' so it reads 'To view the Experiment please click the link below .' (includes replacing the colon with a full stop).

Visualised changes:

Currently rendering as:

[aislinnpearson]

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):

• edit the title, changing it from '[Farm Name]: Update to your Research Design in FarmOS' so it reads '[Farm Name]: Update to your Experiment in FarmOS' (note the F in FarmOS is already capitalised here).
• edit '[Name] has edited an Research Design you are associated with in FarmOS' so it reads '[Name] has edited an Experiment Design you are associated with in FarmOS. '.
• edit 'To view the Research Design please click the link below :' so it reads 'To view the Experiment Design please click the link below .' (includes replacing the colon with a full stop).

Visualised changes:

Currently rendering as:

[aislinnpearson]

PLANS

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

• edit the title, changing it from '[Farm Name]: Update to your Research Plan in FarmOS' so it reads '[Farm Name]: Update to your Experiment Plan in FarmOS' (note the F in FarmOS is already capitalised here).
• edit '[Name] has edited an Research Plan you are associated with in FarmOS' so it reads '[Name] has edited an Experiment Plan you are associated with in FarmOS. '.
• edit 'To view the Research Plan please click the link below :' so it reads 'To view the Experiment Plan please click the link below .' (includes replacing the colon with a full stop).

Visualised Changes:

Currently rendering as:

[aislinnpearson]

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]

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.