JIRA Tip: Using Message Fields

The Message Custom Fields provided by the JIRA Toolkit plugin have many great uses. In this post, I’d like to show several of my favorite ways to use them on a JIRA screen.

I humbly tip my metaphorical hat to Neal Applebaum whose JTOOL-75 post got me started with these fields.

Grouping related fields

If you have a JIRA screen with many fields, use them to group related fields, so the form can be visually scanned to quickly locate the desired section.

Example 1. Grouping related fields

Example 1. Grouping related fields

 

Example 2. Grouping related fields

 

Example 3. Grouping related fields

Example 3. Grouping related fields

 

Providing additional information

I use these types of boxes when there is a need to communicate information about the project itself, the service level agreement (SLA) dictating what sort of turnaround time the user can expect, etc.

Example 4. Additional Information

 

Example 5. Additional information

Example 5. Additional information

 

Example 6. Additional Information

 

Example 7. Additional Information

 

Instructions

Sometimes it’s just nicer to provide instructions in a colored box than just text.

Example 8. Instructions

 

Example 9. Instructions

 

Important Warnings

Warnings are a very effective usage for these message fields, especially if you use a class that includes an icon.

Example 10. Important Warning

 

Example 11. Important Warning

 

Attachments

Another common usage is to deal with Attachments. If your project’s Create screen allows the user to upload a file attachment, then there is a risk that the attachment selection is “lost” if an error occurs – such as the user forgetting to supply a required field. If this occurs, the user must select the attachment again before clicking Create. Since the need to do this may not be obvious, JIRA projects may opt to:

  1. Disallow the uploading of an attachment on the Create screen, but perhaps remind the user that it can be done immediately after the issue is created.
  2. Allow the uploading of an attachment on the Create screen, but warn the user about re-selecting the file(s) should an error occur.

The following shows how message boxes were used to communicate the project’s attachment strategy.

Example 12. Attachments

 

Example 13. Attachments

 

Example 14. Attachments

 

If you have additional suggestions on to leverage Message Custom Fields, please share in the comments!

,

6 Responses to JIRA Tip: Using Message Fields

  1. Neil Arrowsmith January 16, 2012 at 4:33 am #

    We use the “warning” and “info” type styling a lot on our messages. As part of testing an upgrade from Jira 4.0.1 to 4.4, i’ve discovered that the div class you need to use has changed in some cases

    So for old , I found I had to change the fields to use

    infoBox still worked, but there may be other changes I guess.

  2. Matt Doar January 16, 2012 at 1:12 pm #

    I’ve also used the Velocity template field from the toolkit to create links to JQL queries with the values for that issue automatically inserted, e.g

    Links: Requirements | Deployments | Related

    and these are text such as

    Requirements |
    Deployments

    • Matt Doar January 16, 2012 at 1:13 pm #

      Rats, the blog editor converted the HTML into rendered text.

  3. Eric October 11, 2012 at 4:16 am #

    All this looks great !
    Is there a way to make these fields appear in the creation page ?

  4. Bruce November 27, 2012 at 11:29 pm #

    The “Message Custom Field” would not be shown again if the issue form validation is failed, no html elements found also.
    why?

  5. djbdjb00djb@gmail.com July 2, 2013 at 11:40 pm #

    How to using Message Fields Grouping related fields ?

Leave a Reply

Simple Share ButtonsShare:
Simple Share Buttons