Skip to end of metadata
Go to start of metadata

As a plugin development manager, I want users of my plugins to be able to easily report bugs that they find by leaving a message. I want them to be prompted to provide the required information that my team needs in order to identify and investigate the problem. I also want to be able to track who has found a bug so that my team can discuss this with them further.



Due to the highly customizable nature of Form Mail, you can create forms that meet a variety of requirements and capture very specific information. This can help simplify the process for your customers, they simply use the form to help you capture the information you need to get moving and allowing you to focus on improving your quality of service.

 

We are going to be:-

  • Using mandatory fields to capture the most important information
  • Validating the users email
  • Using a pre-speciifed form mail
  • Using a radio button to see whether the user is happy to be contacted
  • Preventing Spam by using captcha to make sure that anonymous (i.e. users not logged in) aren't bots!
  • Using the default mail success message 

Prerequisites

  • Predefined form mail created and id known
  • Space permissions

 

Instructions

  1. Navigate to the page you wish to use for bug reporting
  2. Use the {mail-form} macro and set the destination using the id i.e. {mail-form:id=BugReport}

  3. Set a subject header using {mail-input}

    {mail-input:type=hidden|name=subject|value= Bug Report}
  4. Use the {info} macro to create a frame for your mail form and add an information tool tip. Include the remaining macros inside this info macro

  5. Use {mail-input} macros to create a field to capture the users name

  6. Use the {mail-input} macro to ask for the users email address, set this as required and set validity to email. You can do this inside the macro tool tip.



  7. Request additional information using {mail-input} and setting whether the fields are a mandatory requirement or not. We recommend that you leave the cssStyle field free so that Atlassian default styling will be applied, but feel free to make the size as small or as large as you like!. Our example has set the style to 'width: 253px; height: 12px;'
    1. What version of Confluence are you using? Required
    2. What were you doing when you discovered this bug? 
    3. Steps to reproduce. Required
    4. Any additional information
  8. Add a radio button requesting whether they would like to discuss this bug with someone further. Your support team can respond better if they know that your client wishes to talk about the bug with them!
    {mail-input:name= Contact|type=radio}
  9. Add the {mail-captcha} macro. This uses Confluences Spam filters and works according to your spam prevention filters.
  10. Finally, add the {mail-submit}
  11. By using mail-submit and not providing a corresponding mail-success message, Form Mail will generate its own automated mail success message.



{mail-form:id=BugReport|destination=example@test.com}
{mail-input:type=hidden|name=subject|value= Bug Report}
 
{info:title=Bug Report} 
Please provide information on the bug you have found
 
{mail-input:type=text|name=Users Name|labelText=Your Name}

{mail-input:type=text|name= Email Address of Finder|validation = email|labelText=Email: } 

{mail-input:type=text|name=environment|labelText=What Version of Confluence are you using?} 

{mail-input:type=text|name=Discovered Doing|labelText=What were you doing when you discovered this bug?} 

{mail-input:type=text|name=steps|labelText=Steps to reproduce} 

{mail-textarea:name=additional information|labelText=Any additional information} 
 
{mail-input:name=Contact|type=radio||labelText=Would you be happy to discuss this with someone further? }
 
{mail-captcha}
 
{mail-submit:Send Report}{info}
{mail-form}
  • No labels