-
Notifications
You must be signed in to change notification settings - Fork 0
Delivery Setup
The datadelivery.genome.duke.edu website allows users to deliver DukeDS projects to other users. Deliveries can be created using either the datadelivery.genome.duke.edu website or the ddsclient command line tool. Emails are sent to the users involved in delivery. The contents of these emails are generated using templates.
Please contact gcb-help@duke.edu so we can work with you to setup your delivery email templates.
The following is a list of email template names and when they are used.
| Email Template Name | Use |
|---|---|
delivery |
Sent to the delivery recipient when a delivery is created |
accepted_recipient |
Sent to the delivery recipient after a delivery is accepted |
accepted |
Sent to the sender when a delivery is accepted |
share_file_downloader |
Sent to users who will receive download permissions when a delivery is accepted. |
declined |
Sent to the sender when a delivery is declined |
delivery_canceled |
Sent to the recipient when the sender cancels a delivery |
Email templates consist of a subject and a body. Both subject and body support including variables which will include dynamic content. A user can include the name of the project being delivered in the subject of an email. These variables will be surrounded by double curly brackets(braces). For example to include the project's name in a use would use {{ project_name }}. This text will be replaced with the actual project name before the email is sent.
| Variable Name | Description |
|---|---|
project_name |
Name of the project in Duke Data Service |
recipient_name |
Full name of the user receiving the delivery |
recipient_email |
Email address of the user receiving the delivery |
sender_email |
Email address of the user sending the delivery |
sender_name |
Full name of the user sending the delivery |
project_url |
URL of the project in Duke Data Service Web Portal |
accept_url |
URL where recipient can accept or decline delivery (delivery email template only) |
process_type |
State of the delivery (e.g. "accept" or "decline") |
message |
Reason given by recipient if delivery was declined (declined email template only) |
user_message |
Additional information supplied by the sender when creating a delivery (delivery email template only) |
Once you contact gcb-help@duke.edu we will email you a text file that contains email templates.
This file consists of a list of email templates. Before each email template will be a NAME line that specifies when the template will be used. After the NAME line will be a SUBJECT line that specifies the text to use for the subject of the email. After the SUBJECT line will be the contents of the email template.
Example:
NAME:delivery
SUBJECT:Delivery of {{ project_name }}
Please accept delivery ...
...
NAME:accepted_recipient
SUBJECT:{{ project_name }}
Thanks for accepting project ...
...
To customize your email templates change this document and email it back to us. Then we will update the software configuration to use these email templates for your user.
When a delivery is created the recipient will receive an email. This email allows the recipient to accept delivery of the project. The delivery email template is used to generate this email. This email template must include the accept_url URL to allow the recipient to accept delivery.
Example delivery email template:
NAME:delivery
SUBJECT:Delivery of {{ project_name }}
{{ recipient_name }},
Your order has been completed. Your data has been uploaded to project "{{ project_name }}".
Please visit the link below to accept this project delivery:
Accept project "{{ project_name }}": {{ accept_url }}
Upon accepting the delivery, you will receive instructions on how to download the data.
{% if user_message %}{{ user_message }}{% endif %}
Regards,
{{ sender_name }}
So if your name is "John Smith" and you deliver a project named "MouseRNA" to user "Paul Hammer" specifying the message "This is the data created for order 123." the following email will be sent to "Paul Hammer".
The email subject line will be:
Delivery of MouseRNA
The email body will be:
Paul Hammer,
Your order has been completed. Your data has been uploaded to project "MouseRNA".
Please visit the link below to accept this project delivery:
Accept project "MouseRNA": https://datadelivery.genome.duke.edu/ownership/?transfer_id=...
Upon accepting the delivery, you will receive instructions on how to download the data.
This is the data created for order 123.
Regards,
John Smith
When a recipient accepts delivery they will receive an email with a copy of the link to the DukeDS project. This email may contain instructions on how to download the data.
Example accepted_recipient email template:
NAME:accepted_recipient
SUBJECT:{{ project_name }}
{{ recipient_name }},
You have accepted delivery of project {{ project_name }}.
You may access it via the following link: {{ project_url }}.
You can download your data using the ddsclient command line tool...
Regards,
{{ sender_name }}
So if your name is "John Smith" and you delivered a project named "MouseRNA" to user "Paul Hammer". Once "Paul Hammer" accepts the project he will receive the following email.
The email subject line will be:
MouseRNA
The email body will be:
Paul Hammer,
You have accepted delivery of project MouseRNA.
You may access it via the following link: https://dataservice.duke.edu/#/project/...
You can download your data using the ddsclient command line tool...
Regards,
John Smith
There are also options to set a CC email address and a Reply-to email address for emails sent with data delivery. The CC email address will receive a copy of emails sent. The Reply-to email address determines who will receive any replies sent in response to a data delivery email. These settings are specific to the email templates associated with your NetID. To change these values email gcb-help@duke.edu.