Enabling hgUserSuggestion
From genomewiki
Introduction
On 26 June 2013, the UCSC Genome Browser team released a suggestion box for feature requests. The suggestion box is handled by a new CGI: "hgUserSuggestion". Mirror sites can enable their own suggestion boxes by configuring hgUserSuggestion to accept requests from users.
Enabling hgUserSuggestion
To enable the hgUserSuggestion CGI on a Genome Browser mirror, add the following parameters to the genome browser configuration file hg.conf in your /cgi-bin/ directory:
# The following 6 parameters are used to set up your browser to accept user suggestions. # After a user submits a suggestion, both the user and the suggestion admin address below # will receive an email containing the suggestion. # email address for the suggestion admin suggest.mailToAddr=suggestion@myuniversitysoe.edu. # sender address for the suggestion email suggest.mailFromAddr=browserAdministrator@mylab.university.edu # Keyword in the mail subject line to help filter out spam suggest.filterKeyword=FORYOUREYESONLY # signature written at the bottom of suggestion emails suggest.mailSignature=My Lab browser administrator # contact address for suggestion follow up suggest.mailReturnAddr=browserAdministrator@mylab.university.edu # browser name used in emails suggest.browserName=myLab Genome Browser
The useage of these parameters will be explained in the following section.
hgUserSuggestion in action
After the user (mirrorfan@abc.edu) submits a suggestion, hgUserSuggestion will
- create a suggestion reference ID which is the user's email address with a time stamp appended at the end as "mirrorfan@abc.edu 2013-07-15 09:35:50"
- send an email to suggestion@myuniversitysoe.edu (value of suggest.mailToAddr) contain the suggestio ID, sunnaries, and details.
- The subject line of the emails will be "FORYOUREYESONLY mirrorfan@abc.edu 2013-07-15 09:35:50", the value of suggest.filterKeyword" can be used to filter out spam mail send to suggestion@myuniversitysoe.edu
- The CGI will then display a confirmation message and send a confirmation email to the user.
- The suggest.mailFromAddr, suggest.mailSignature, suggest.mailReturnAdd and suggest.browserName will be used in the confirm mail. For example, The user will receive a mail like this:
From: browserAdministrator@mylab.university.edu Subject: Thank you for your suggestion to the MyLab Genome Browser To: mirrorfan@abc.edu Someone (probably you, from IP address 123.456.78.9) submitted a suggestion to the MyLab Genome Browser regarding "Ovis aries Oar_v3.1". The suggestion has been assigned a reference number of "mirrorfan@abc.edu 2013-07-15 09:35:50". If you wish to follow up on the progress of this suggestion with browser staff, you may contact us at browserAdministrator@mylab.university.edu. Please include the reference number of your suggestion in the email. Thank you for your input, My Lab browser administrator Your suggestion summary: Ovis aries Oar_v3.1 Your suggestion details: The Ovis aries 3.1 sequence is available at NCBI now. Please create a browser for this assembly.
