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.
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.
Sometimes it’s just nicer to provide instructions in a colored box than just text.
Warnings are a very effective usage for these message fields, especially if you use a class that includes an icon.
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:
- 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.
- 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.
If you have additional suggestions on to leverage Message Custom Fields, please share in the comments!