search

VEuPathDB / service-dataset-access

Apache License 2.0
0 stars 2 forks source link

Study Access request: Per-study Verbiage changes needed to auto-emails in response to approvals #73

Open danicahelb opened 1 year ago

danicahelb commented 1 year ago

The PERCH study team has requested that the automatic email that gets sent to the data requestor after approval contains verbiage (to be sent by Chrissy from PERCH) indicating (1) how they should acknowledge & cite PERCH and (2) that they should notify the study team in advance of all published papers or abstracts and presentations.

How can we change the verbiage of these auto-emails? Should we just hardcode this for the 8 PERCH studies?

danicahelb commented 1 year ago

Info from @dmgaldi:

Right now, the template verbiage lives here. We'd need for there to be some optional attribute on the dataset with custom verbiage. There's not a way yet to add a study-specific message.

We could potentially hard-code it as a temporary measure if we think this is an exceptional case

danicahelb commented 1 year ago

How much work would it be to add functionality for study specific messages? Right now we just need this for PERCH, but I wouldn’t be surprised if more studies would like this in the future. If not much work, we should make it customizable

dmgaldi commented 1 year ago

@danicahelb How would we envision this new property interacting with the default template?

Would the custom verbiage for a study be completely override the verbiage in the default template? Or could we have a part of the template that is populated by study-specific property?

The latter would be much easier for us, because we can interpolate all of the template variables once instead of having template variables nested inside other template variables.

An example of the study-specific property body would be something like:

Your request to access "$$dataset.displayName$$" data on ClinEpiDB has been approved. Navigate to the "Download" tab of "$$dataset.displayName$$" to download the data. Please cite that you accessed data via ClinEpiDB.

"$$dataset.studySpecificVerbiage$$"

Thank you!

danicahelb commented 1 year ago

@dmgaldi part of the template can be populated by a study-specific property

@aurreco-uga please add a new prop in presenters "customApprovalEmailBody" which will be concatenated with the default verbiage in https://github.com/VEuPathDB/service-dataset-access/blob/master/src/main/resources/email.yaml