search

Sage-Bionetworks / SynapseWorkflowOrchestrator

Apache License 2.0
3 stars 2 forks source link

Update "Submission Processing Started" email subject title to include evaluation name #18

Closed thomasyu888 closed 4 years ago

thomasyu888 commented 4 years ago

Is it possible to get the evaluation queue id name to be sent to the submitter in the "Submission processing started" email? The email currently doesnt mention which evaluation queue people submitted to and I have a notification step in my workflow to do that.

The subject looks like:

Submission to 'My Queue Name' received!

brucehoff commented 4 years ago

@thomasyu888 are you sure this message is sent by the Orchestrator? I don't see it in the code base. https://github.com/Sage-Bionetworks/SynapseWorkflowOrchestrator/blob/master/src/main/resources/SubmissionProcessingStarted.txt

thomasyu888 commented 4 years ago

This message is not sent by the orchestrator, it is sent by my workflow. Current whats sent by the orchestrator subject is:

submission process started...

I'm suggesting that the orchestrator sends a more informative "workflow started" email.

brucehoff commented 4 years ago

@thomasyu888 I am confused. In your initial post you say, "Is it possible to get the evaluation queue id name to be sent to the submitter in the 'Submission processing started' email?" You then say, "This message is not sent by the orchestrator, it is sent by my workflow." So wouldn't this be a change to your workflow, rather than to the Orchestrator?

brucehoff commented 4 years ago

Did you mean to ask, "Is it possible to get the evaluation queue id and name to be sent from the Orchestrator to the workflow so that the workflow can include this information is its 'Submission processing started' email?"

thomasyu888 commented 4 years ago

@brucehoff, no let me explain. my apologies for the confusion. Currently the orchestrator sends a workflow started email with the subject title Submission Processing Started , and its contents:

Dear Thomas Yu (thomas.yu):

Your submission (submission ID ...) is in progress.  Log files produced while your workflow is running will be periodically uploaded here: https://www.synapse.org/#!Synapse:syn.... Further notification will be provided when it is complete.

Sincerely,

Submission Queue Administration

In this email, it doesn't tell the submitter which queue they submitted to, so if they submitted to 6 different queues, they would receive 6 of these emails with the same subject title, just with different submission ids. That being said, the submission id doesn't tell the submitter about where they had submitted to.

I am proposing that the orchestrator sends a workflow started email with the subject title Submission to 'My Queue Name' processing. Currently, I have set SUBMITTER_NOTIFICATION_MASK, an environmental variable used by the orchestrator, to not send the default orchestrator workflow started email, because I include the evaluation queue name in the notification email I send from my workflow.

The solution I stated at the end works just fine, I just thought adding the queue name would be a nice addition to the orchestrator submission processing started email template.

brucehoff commented 4 years ago

Yes, that makes sense. Thanks for clarifying.

brucehoff commented 4 years ago

https://github.com/Sage-Bionetworks/SynapseWorkflowOrchestrator/commit/00e4bd2e8f3fea8744ee01d2fafe97a8c216e11e