JIRA Labels Plugin

Name JIRA Labels Plugin
Vendor Atlassian Pty Ltd (Website)
Authors David Peterson, Rich Wallace
Homepage http://confluence.atlassian.com/display/JIRAEXT/JIRA+Labels+Plugin
Issue Management http://developer.atlassian.com/jira/browse/LBL
Categories Content
Version 2.1.4
Availability JIRA v3.11 to v3.12.3
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/JIRAEXT/JIRA+Labels+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/jira/jira-label-plugin/tags/2.1.4/
Download JAR jira-labels-plugin-2.1.4.jar

Compatibility With JIRA

Plugin Version 3.10.2 3.11 3.12.1 Tested Supported
2.1.4 David Chui (Jan/28/2008)  
Product Version Change

This plugin now requires 3.11 or greater. Versions older than 2.0.3 are not recommended.

Description/Features

The JIRA Labels Plugin gives you the ability to tag issues with arbitrary labels. What are tags? They are simple, one word descriptors that help you organize issues. Check out the del.icio.us explanation or the one from Flickr-- JIRA Labels work just like that.

Once installed, you can add a 'Labels' custom field to any project, and you'll be able to add new labels to an issue from the View Issue screen or from the Edit Issue screen. You'll also be able to add tags to lots of issues quickly by using the Issue Navigator.

Installation

  1. Copy the jar listed above into JIRA's WEB-INF/lib directory.
  2. Restart JIRA.
  3. You're done!

Configuration

To actually use the plugin, do the following:

  1. Log in as an administrator.
  2. Enter the 'Administration' section.
  3. Select 'Custom Fields'.
  4. Add a new custom field.
  5. Select the 'Label Field' type.
  6. Fill in a name and description for the field (e.g. 'Labels')
  7. Select what type of issues it is available for.
  8. Select what screens it will show up on.
  9. Done! Just add a new issue matching your settings to see it in action.

Usage

Once this is done, enter labels as single words separated by spaces. For example, 'david jennifer' would be two labels, 'david' and 'jennifer'.

Click on the 'edit' link to add new labels. You'll be offered a set of suggested labels, chosen from previously used labels for the project. Click on any of these to tag the issue with that label. Or type in your own and click 'Add'.

Once the issue has been labeled, you can search for labels with the standard issue finder, as well as viewing all issues with a given label by clicking on the label in the issue itself, or the search results for the issue (after adding your custom field as a column in the search results, of course).

When you're viewing issues in the Issue Navigator, click the 'edit' link in the labels column, and a popup window will appear. You can enter labels here just as you would on the Veiw Issue screen and they'll automatically be added to that issue, all without leaving the search screen.

Version History

Open Issues

Atlassian Developer Network JIRA (21 issues)
T Key Summary Reporter Status
Bug LBL-108 Labels Editor does not display labels added to an issue when there are many suggested labels Jeff Schnitter Open
New Feature LBL-107 Add ability to see exact label counts Gregory Brauer Open
Improvement LBL-105 Clicking a label through from the issue should go to that project's issue navigator Mark Chaimungkalanont Open
Improvement LBL-100 Seperate label permissions from edit issue permission Anton Mazkovoi Open
Improvement LBL-99 Label in combination with a preset filter Bert Vermeulen Open
Improvement LBL-93 Speed up tyhe display of the labels custom field on the view issue page Anton Mazkovoi Open
Improvement LBL-77 Allow to generate statisitics based on the labels custom field Anton Mazkovoi Open
New Feature LBL-76 Expose Jelly tags for label operations Yoz Grahame Open
Improvement LBL-74 Allow to filter labels from archived releases Urs Reupke Open
Improvement LBL-68 Improve Bulk Label edit to ability to Add label to multile issues rather than overwrite field David Ruddock Open
New Feature LBL-64 Select either show all labels or show heat map in portlet Richard Wallace Open
New Feature LBL-58 Ability to search for multiple labels using 'AND' logic Jay Sellers Open
New Feature LBL-56 Create a new portlet for popular issues Jonathan Nolen Open
New Feature LBL-36 "Browse" issues with labels Mark Chaimungkalanont Open
New Feature LBL-33 Private label visibility Karsten Silz Open
New Feature LBL-31 Allow portlet to display All labels, instead of just per project Jonathan Nolen Open
Bug LBL-27 EDIT jumps to JIRA when used in Confluence as portlet Bob Swift Open
Task LBL-26 Question: Search for Issues without Label? Mathias Golombek Open
New Feature LBL-6 Provide ability to search for labels using wildcards yuval yeret Open
New Feature LBL-5 Enable integration with the Filter Statistics portlet Rob Oxspring Open
Improvement LBL-4 Ability to exclude a label from search Micah Almond Open

Screenshots

(view as slideshow)
         
  New screenshot to show the current look and feel.   Scaled down the size of the image.      
 
               
               
 

Labels

 
  1. Jan 12, 2007

    Bob Swift says:

    Is it possible to add multiple "labels" type fields to the same issues? For inst...

    Is it possible to add multiple "labels" type fields to the same issues? For instance, I might want to have a custom field that behaves in this way, but is for another purpose. Of course I still want to have the usual labels field that represents labels.

    1. Jan 12, 2007

      Jonathan Nolen says:

      You can do this, and it will work except for the perproject views: the Project T...

      You can do this, and it will work except for the per-project views: the Project Tab and the Dashboard portlet. Those expect there to be only one field. But if you can live without those features, you should be able to add multiples.

      1. Jan 12, 2007

        Bob Swift says:

        So, does it take the first such field or blowup? If the former, then just make s...

        So, does it take the first such field or blow-up? If the former, then just make sure the labels field is added first would seem to be ok.

        1. Jan 15, 2007

          Jonathan Nolen says:

          Fairly certain that it fails with a nice error. It does not, however, take the f...

          Fairly certain that it fails with a nice error. It does not, however, take the first instance. I considered doing that, but decided that it would be more confusing.

  2. Apr 19, 2007

    Jay Sellers says:

    Is there a way to search for tasks based on multiple labels using "AND" rather t...

    Is there a way to search for tasks based on multiple labels using "AND" rather then "OR"?  I'd like to be able to filter tasks that are labled with both FOO and BAR, for instance.

  3. Jul 30, 2007

    Jonathan Nolen says:

    Hi Folks, The labels plugin was under fairly heavy development last week. Many ...

    Hi Folks,

    The labels plugin was under fairly heavy development last week. Many of the issues that were reported in this thread have been resolved. I've removed a whole bunch of comments to reduce conmfusion about what has and hasn't been fixed.

    If you encounter issues, please file them in the JIRA project rather than here. (Email me if you need an account.)

    Cheers,
    Jonathan

  4. Aug 03, 2007

    apolo says:

    jira 3.10.1 jiralabelsplugin2.0.2 an error occurs when attempting to find 200...

    jira 3.10.1
    jira-labels-plugin-2.0.2

    an error occurs when attempting to find

    2007-08-03 12:48:52,455 http-8443-Processor12 WARN [issue.customfields.searchers.AbstractCustomFieldSearcher] Searcher customfield_10212 (LabelSearcher) tried o search with context it does not exist for. The search context is com.atlassian.jira.issue.search.SearchContextImpl@7cc4fe[[],[]]

    how fix this?

  5. Aug 10, 2007

    Danny Ackerman says:

    Hi,  I beleive I installed the control correctly, however, I do not see the...

    Hi,

     I beleive I installed the control correctly, however, I do not see the "Edit" or "Add" links when looking at an issue.  I see the field for my custom control, but its completely blank with no actions.

    Any ideas?

    Thanks!

  6. Sep 04, 2007

    Bettina Zucker says:

    Hello, I have Jira 3.9.1 as production system and I have trouble choosing the co...

    Hello,

    I have Jira 3.9.1 as production system and I have trouble choosing the correct release of this plugin.

    2.0 works somehow, but with such many warnings that jira performance suffers and serious problems when making an excel export (see LBL-16).

    2.0.1 fails already while loading.

    2.0.2 is specified to work for Jira 3.9 to 3.11 in the atlassian-plugin.xml, but almost any action concerning labels fails, e.g. viewing or editing an issue containing labels, searching for a label, including labels as a navigator column, doing an excel export (LBL-57) do not work with Jira 3.9.1.

    2.0.3 does not work for 3.9, it is specified to work only for 3.10 to 3.11.

    At present I'm still using 2.0 because the other versions are working worse!

    I'm not going to upgrade to Jira 3.10 in the next time because there are no new features which my users really need.

    Is there any hope to get a version of this plugin which works well with Jira 3.9.1? 

    Regards

    Bettina Zucker

    1. Sep 11, 2007

      Jonathan Nolen says:

      Hi Bettina, As of 2.0.4, we've eliminated a lot of fairly serious issues with b...

      Hi Bettina,

      As of 2.0.4, we've eliminated a lot of fairly serious issues with both performance and functionality. It's not trivial to backport these fixes to 3.9 or earlier, so we're only going to continue developing this plugin for 3.10 and later.

      Version 2.0 is probably fine to continue using if it works for you and the performance is acceptable.

      I'm sorry for the inconvenience, but when you're ready to upgrade, the plugin will be waiting for you.

      Cheers,
      Jonathan

  7. Sep 12, 2007

    Timothy Wise says:

    Hello: We're using Labels pretty effectively for our team by tagging defects in...

    Hello:

    We're using Labels pretty effectively for our team by tagging defects in our project and in projects which contain artifacts/services which our product uses. However, is there any Jira portlet available similar to the 2-dimensional or single dimensional filter statistics but instead report on what is tagged with a group of lables, rather report on what labels have jiras in what status (i.e.create a filter looking for that label). For example, all the labels that we are using are prefixed with a comment TLA, ideally I'd like to know all labels that begin with that TLA on each row and their status or priority or assignee for each column. Does such a label portlet yet exist? Is this something we can create/extend ourselves?

    Thanks in advance.

    Tim

    1. Sep 13, 2007

      Jonathan Nolen says:

      Yes, you should be able to create a filter based solely on matching a label. Jus...

      Yes, you should be able to create a filter based solely on matching a label. Just look for the labels searcher in your issue navigator. Once that's done, you can expose it through a portlet in using the normal methods.

      Cheers,
      Jonathan

      1. Sep 14, 2007

        Timothy Wise says:

        No, that isn't really what I'm after. I can easily create filters for the leable...

        No, that isn't really what I'm after. I can easily create filters for the leables, and can then update the portlets to use those filters.

        What I need is a portlet that allows me to display a matrix of my stats for the jiras that have the set of labels that are of interest to me.

        For example, a portlet that shows me the number jiras that have particular labels and their particular status (or assignment, etc). So, there would be multiple rows, one row for every label that starts with XYZ* and then one column for each status.

        Open Accepted In Progress Code Complete
        XYZUseCase1 n n n n
        XYZUseCase2 n n n n
        XYZUsecase3 n n n n

        I want a quick dashboard to see where my application stands without having to review upwards of 25 filters. As I am in a large organization and my categories don't span that organization I'm reluctant to request a global parameter that may or may not apply across the organization. However, I have jiras in other teams projects that affect my use cases so Labels is a relatively elegant solution. But I just can see all the Jira's in one easy place and a Portlet would solve that problem.

  8. Nov 01, 2007

    Michael Vorburger says:

    Would it be possible to have changes to labels/tags (add & remove) reflected in ...

    Would it be possible to have changes to labels/tags (add & remove) reflected in that audit/changes section thing at the bottom (like when you would change any other field) ? For us, this would be very useful for traceability. Thanks.

  9. Nov 06, 2007

    Pamela Chow says:

    I'm using plugin version 2.0 in JIRA version 3.8.1. The performance seems fine f...

    I'm using plugin version 2.0 in JIRA version 3.8.1. The performance seems fine for our usage. However, neither the Dashboard portlet or the Heatmap Project Tab work.

    Yes I've checked that they are enabled in the Plugin manager. But still, all that appears in the project tab is the tab but no content. Likewise the portlet can be added to the dashboard but shows no data. Any ideas what might be wrong?

    Does the custom field name have to a specific name e.g. Labels and not say Tags?

    Thanks 

  10. Nov 12, 2007

    Oscar Garcia says:

    Hi, I was getting an error when I try to add a label to an issue. "Invalid reply...

    Hi,

    I was getting an error when I try to add a label to an issue. "Invalid reply from server". My setup is 3.11 and 2.1.3 of the labels plugin. I tried with both Camino and Firefox (latest versions also) but no luck.

    I have apache in front of jira-standalone. I tried without apache and it worked. What kind of requests does the plugin make? Anything special I have to map to go against tomcat?

    Thanks

  11. Nov 14, 2007

    Sophie Tatham says:

    Hi, I'm looking at migrating a bugzilla database into JIRA and want to use the L...

    Hi,

    I'm looking at migrating a bugzilla database into JIRA and want to use the Labels Plugin for our bugzilla keywords. Do you have any thoughts on the best way to migrate the existing data? As far as I can see the existing bugzilla import feature doesn't support keywords at all.

    Thanks,

    Sophie

  12. Dec 03, 2007

    Yoz Grahame says:

    For those wanting a quick way to bulkadd/bulkremove labels, I've created these t...

    For those wanting a quick way to bulk-add/bulk-remove labels, I've created these two bookmarklets:

    Bulk Add:
    javascript:g=YAHOO.util.Dom.getElementsByClassName;a=g('rowNormal');a=a.concat(g('rowAlternate'));l=a.length;t=window.prompt(l+' issues found in page. Enter the tag to add:');c=l;for(i=0;i<l;i++){AjaxHelper.addLabel(a[i].id.substring(8),t,'customfield_10260',function(){c--;if(c==0&&window.confirm('Tag added. Reload the page now?')){window.location.reload();}})}

    Bulk Remove:
    javascript:g=YAHOO.util.Dom.getElementsByClassName;a=g('rowNormal');a=a.concat(g('rowAlternate'));l=a.length;t=window.prompt(l+' issues found in page. Enter the tag to remove:');c=l;for(i=0;i<l;i++){AjaxHelper.removeLabel(a[i].id.substring(8),t,'customfield_10260',function(){c--;if(c==0&&window.confirm('Tag removed. Reload the page now?')){window.location.reload();}})}

    To use them, add them as Bookmarks/Favorites in your browser. (NOTE: You have to change the string "customfield_10260" to be the correct custom field ID for labels in your Jira install. If anyone can suggest the fastest way for people to find this out, I'd appreciate it!)
    Then:
    1: Perform a search in Jira that returns all the issues you want to bulk-edit
    2: Click the bookmarklet
    3: In the pop-up dialog, enter the label to be added/removed
    4: The browser will add or remove that label on all the issues listed on the page. You don't need to worry about issues that already have the action performed - e.g., issues that already have the label you're adding won't get a duplicate. (Note that if the result set for the search spans multiple pages, you will need to use this bookmarklet on each page, or change the search parameters to display more results per page)
    5: The browser will ask if you want to reload the page, to show the new labels.

    I hope that people find this useful!

  13. Dec 06, 2007

    Dan says:

    Hi, I have the same question/request &nbsp;as Sophie.&nbsp; Is there any movemen...

    Hi,

    I have the same question/request  as Sophie.  Is there any movement on that?

    Thanks,

    Dan

    1. Dec 17, 2007

      Sophie Tatham says:

      Hi, &nbsp;I've had a further look at this and am planning to customise the Bugzi...

      Hi,

       I've had a further look at this and am planning to customise the Bugzilla migration code to turn Bugzilla keywords into JIRA labels. The default migration code is freely available here. Working with Custom Fieldsgives some pointers as to how to populate custom fields in code.

      At the same time I'll be able to twiddle a couple of other things (for instance I can't see that the Bugzilla Priority field is currently mapped).

      I haven't tried writing the code yet but it looks quite easy. Famous last words I should get to it some time next month.

      Hope this helps,

      Sophie

  14. Jan 14

    Jeff Mychasiw says:

    This looks like great plugin.&nbsp;&nbsp; \\ Is it possible to use the CSV impor...

    This looks like great plug-in.  

    Is it possible to use the CSV import utility to import and map a field into a  label?

  15. Feb 05

    Patrick Berry says:

    Can you remove labels from the system entirely? I can't seem to find that easy b...

    Can you remove labels from the system entirely? I can't seem to find that easy button.