annotate sendmail.xml @ 3:5f5cd5d373cb draft default tip

Deleted selected files
author geert-vandeweyer
date Thu, 13 Feb 2014 03:50:50 -0500
parents aff68aba2f62
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
1 <tool id="sendemail" name="Send Mail On Completion" version="0.0.1">
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
2 <description></description>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
3 <command interpreter="perl">
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
4 sendmail.pl -u '$__user_email__'
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
5
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
6 ## subject
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
7 #if $subjectfromselect.subjectsource == "typed" :
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
8 #if $subjectfromselect.typedsubject != "":
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
9 -s "${subjectfromselect.typedsubject}"
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
10 #end if
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
11 #elif $subjectfromselect.subjectsource == "other":
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
12 -s "Galaxy Job Finished on ${subjectfromselect.subjectfile.display_name}"
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
13 #elif $subjectfromselect.subjectsource == "input1":
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
14 -s "Galaxy Job Finished on ${input1.display_name}"
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
15 #end if
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
16
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
17 -d "${input1.display_name}@@@
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
18 #for $q in $datafiles
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
19 ${q.input2.display_name}@@@
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
20 #end for
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
21 "
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
22
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
23 -o $output
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
24
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
25 </command>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
26 <inputs>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
27 <conditional name="subjectfromselect">
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
28 <param name="subjectsource" type="select" label="Provide a Subject for the email :" help="If no subject is specified, a generic email will be send." >
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
29 <option value="typed">Type the subject</option>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
30 <option value="input1">Base the subject on the first selected file</option>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
31 <option value="other">Base the subject on a file selected here</option>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
32 </param>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
33 <when value="typed">
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
34 <param name="typedsubject" type="text" size="25" label="Subject for email" />
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
35 </when>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
36 <when value="other">
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
37 <param name="subjectfile" type="data" label="Select a file from the history to base the subject upon" />
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
38 </when>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
39 </conditional>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
40
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
41 <param name="input1" type="data" label="Datafile to be completed:"/>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
42 <repeat name="datafiles" title="Data Files">
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
43 <param name="input2" type="data" label="Select" />
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
44 </repeat>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
45 </inputs>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
46 <outputs>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
47 <data format="txt" name="output" label="Email Sent." hidden="true" />
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
48 </outputs>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
49
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
50 <help>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
51 **What it does**
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
52
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
53 This tool sends an email to notify you when a certain analysis has finished. It takes any datfile(s) as input and sends the mail as soon as they are ready. Use it to notify you of workflow completion. In workflows, this can be set in the workflow editor, but this tools can be handy to get notifications for manually started jobs.
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
54
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
55 **Input**
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
56
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
57 Datasets:
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
58 Any dataset, or multiple datasets. They will be listed in the email.
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
59
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
60 A subject:
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
61 You can specify the subject of the mail yourself, or use a datafile. In that case, the subject will be of the form "Galaxy Job Finished on Datafile_Name". If none is specified, you will just recieve a mail with "Galaxy workflow finished" as subject.
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
62
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
63 **Output**
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
64
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
65 None.
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
66
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
67 </help>
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
68
aff68aba2f62 Replace XML with correct one. Apologies for the mistake
geert-vandeweyer
parents:
diff changeset
69 </tool>