JIRA Toolkit Plugin

Atlassian Marketplace

Atlassian Marketplace will have more up to date information on this plugin about releases and issues.

Using the JIRA Toolkit in OnDemand

This add-on is pre-installed in all OnDemand instances, however it is disabled. To enable it, please contact support.

Using the JIRA Toolkit

As with all plugins from Atlassian Labs, please take care using this plugin as we do not officially support them as a priority. That said, we're generally happy to answer questions and will most likely address bugs that get raised.
We also use it in our support system at the moment. The full source is also provided so you can modify it, fix problems or even contribute back some code.

Description/Features

The toolkit is a set of neat custom fields Atlassian developed for their own use, particularly when using JIRA for customer support.They provide a simple workaround for current limitations to JIRA or solutions to some idiosyncratic problems. Think of it as JIRA Custom fields sandbox if you will. It's also a showcase for how simple custom fields can be used get more out of your of JIRA, especially for filtering on information that would otherwise be unavailable.

Installation

  1. Download the jar and install in the appropriate plugin directory
    • If you are using Toolkit 0.8 or later (on JIRA 4.0 or later) - place it in your plugins2 installation directory (<jira-home>/plugins/installed-plugins/)
    • If you are using Toolkit 0.7 or earlier (on JIRA 3.13 or earlier) - place it in your webapp's lib folder (For Standalone/Tomcat it is in the WEB-INF/lib dir)
  2. Restart JIRA
  3. Enable the plugin as shown here
  4. New custom field types will now be available to your system
  5. Add a new custom field of the types you want in your system from the "Admin" > "Issue Fields" > "Custom Fields"
  6. Reindex JIRA. This is quite important as most of the custom fields are "calculated" custom fields, which means until you reindex, the values will not be valid.

The Custom Field Types

Custom Field Type

Description

Screenshots

Message Custom Fields

These fields are used to added arbitrary HTML to edit and view pages. Edit the default value of these fields and you can easily add custom messages to various screens or otherwise change the look and feel of JIRA. You can also use Velocity templates in these fields which makes your changes easily portable across different JIRA versions.

Original Estimate Range Search

Search original estimates with a number range searcher. Searches are in hours only.

Number of comments and attachments

You can now also display and search for the numbers of comments and attachments of an issue. You can also perform range searches on either of them.

Last Resolved Date

This field looks up the date when status was last changed to Resolved. You can perform full date range searches on it. NOTE:Some users have reported issues using this field with Oracle. We're still investigating what could be wrong. You can find another implementation of this at JIRA Charting Plugin

Multi Issue Key Searcher

This is a custom field that will allow you to specify multiple issue keys in an issue navigator search field and then order them in any way you like within the issue navigator results. To use this, you must add a global custom field of type 'Multi Issue Key Searcher' and add the custom field as a column to your issue navigator. Once your results are displayed you can click on the column's header to get the sort options. You will be able to move individual issues up or down or remove them from the list altogether. See this tip to help you generate a list of issues from an existing filter.

Domain of Reporter

The domain name of the reporter's e-mail - can be used as the reporter's "Company". As of 0.2, you clicking the company will try to open the site. You can also search for all issues with that company from the view screen. Since 0.7, there's also a type for assignee.

Days since last comment

Number of minutes, hours, days & weeks since the last comment on the issue. As of 0.2, displays relative time ("1 minutes ago etc"). Moreover, if the issue has not been replied to for > 7 days and is not resolved, the line in the issue navigator will be coloured red.

Last commented by a User Flag

Displays true if last commenter who is not a JIRA developer (member of 'jira-developers'). Comes with its own checkbox searcher

JIRA Toolbar

Allows you to add the Edit & Comment commands to your Issue Navigator.

Participants Field

This field allows you to easily track issues that you've "participated in". These are defined to be any issues you've commented on, raised or are the current assignee. See also the JIRA Extended Participants plugin.

User Property Field

A read-only custom field that displays a user property.

 

Dummy Project Field

Dummy project field to enable multi project search. DO NOT USE. This has been superceded by functionality in JIRA. If you are still using this field, please remove it as it will be removed in future versions.

Listeners

Listener Name

Class

Description

Auto Transition Listener

com.atlassian.jira.toolkit.listener.AutoTransitionListener

Listens for a given event on an issue, and then performs a transition. Please refer to the installation and configuration instructions.

Portlets

Portlet

Description

Screenshots

Quick Create

An issue creation form right on the dashboard, designed for quickly creating issues on behalf of others in a preconfigured project. The reporter may be set to the current user or (as in the screenshot) specified by email address. If the entered email address does not exist in the system, further user details are requested the next screen, and the user is created.

Versions


You need to download the toolkit version that matches your JIRA version:

Atlassian Marketplace

Refer Atlassian Marketplace for the complete list of releases.

Version

JIRA Version(s)

Comments

0.17.0

JIRA 4.3

JIRA 4.3 Compatibility (15 Mar 2011)

0.15.0

JIRA 4.2

Made compatible with 4.2.

0.14.1

JIRA 4.1

Minor bug fix release

0.14.0

JIRA 4.1

Made compatible with 4.1.

0.8

JIRA 4.0

Made compatible with 4.0.
This version is not compatible with any JIRA 3.13 releases or earlier releases.

0.7.30

JIRA 3.13 +

Addind a new condition to the AutoTransitionListener to specify concrete user. Adding telephone number parsing to the Support Request Service

0.7.29

JIRA 3.13 +

Released with JIRA 3.13.2. Fixed a XSS bug in the participants field

0.7.28

JIRA 3.13 +

Released with JIRA 3.13

0.7.27

JIRA 3.12 +

Fixes a bug in the SupportService and in the TimezoneUtils

0.7.26

JIRA 3.12 +

Fixes for SQL data sensitivity

0.7.25

JIRA 3.12 +

Version to use for 3.12. Uses some 3.12 functionality so not backwards-compatible.

0.7.24

JIRA 3.11 +

Version to use for 3.11. Updated to Lucene v2.2 in line with JIRA 3.11 moving to the same Lucene code base . NOTE : You can only run this version on JIRA 3.11 and above. This version of the toolkit will not run on earlier versions of JIRA because the Lucence API has changed, with several methods removed.

0.7.21

JIRA 3.9 +

Version to use for 3.9. Improved support handler (internal for atlassian)

0.7.20

JIRA 3.8 +

Version to use for 3.8

0.7.19

JIRA 3.7.4

internal release

0.7.18

JIRA 3.7.3

Updates and compatibility with JIRA 3.7.3

0.7.17

JIRA 3.7-beta2

internal release

0.7.16

JIRA 3.7-beta2

internal release

0.7.15

JIRA 3.7-beta2

internal release

0.7.14

JIRA 3.7-beta2

Version to use for 3.7

0.7.13

JIRA 3.7-beta1

internal release

0.7.12

JIRA 3.7-beta1

internal release

0.7.11

JIRA 3.7-beta1

internal release

0.7.10

JIRA 3.6.x

 

0.7.9

JIRA 3.6.x

 

0.7.8

JIRA 3.6.x

Participants custom field is faster due to direct SQL statements. A text custom field that gets processed through velocity. Fix bug with changehistory being updated for message field.

0.7.6

JIRA 3.6.x

AutotransitionListener was broken in 3.6. Fixed. Make sure you are using the correct event Ids, they have changed

0.7.5

JIRA 3.6.x

Reflect small API change in JIRA 3.6

0.7.4

JIRA 3.5.x

Fixed a small bug in the Message Custom Field that was causing Move Issue to break

0.7.3

JIRA 3.5.x

Added Auto-Transition Listener

0.7.2

JIRA 3.5.x

Added two message custom fields, one for view and one for edit screens

0.7

JIRA 3.5.x

Added a whole bunch of plugins. attachment count, comments count, original estimates range searching, assignee domain searcher and resolved date custom field

0.6.2

JIRA 3.4.2

updated for 3.4.2

0.6.1

JIRA 3.4.1

Removed securitylevel CF type (use Security Level system field instead) and updated for 3.4.1

0.6

JIRA 3.4

Added the Multi Issue Key custom field and searcher. The Participants field now also supports the "Group and User" searcher

0.5.1

JIRA 3.3

Updated days since last comment to colour the row red

0.5

JIRA 3.3

Added the participants field. Updated for JIRA 3.3 use.

0.4.1

JIRA 3.2

Updated for 3.2 stats mapper changes

0.4

JIRA 3.2-beta

Added a "Dummy Project Field". This is a simple workaround for the very popular issue at http://jira.atlassian.com/browse/JRA-699

0.3

JIRA 3.2-beta

First compatible version with 3.2-beta

0.2

JIRA 3.1

Many minor improvements

JIRA breaks in interesting ways if you use a newer toolkit version on an older JIRA. Please don't!








Using the Dummy Project Field for Multi-Project searching

Multi project search in JIRA

As of JIRA 3.3, multi-project searching is available in the code and the use of this custom field has been deprecated.

The toolkit now includes a custom field that indexes the project as a custom field and has a multi-select searcher on it. This allows for simple multi-project queries. To use it, add the field as a Global custom field, ensuring you add it on all your edit screens to ensure that it'll be properly indexed. When searching, you'll find the field in the custom fields section (it's just a custom field after all). Make sure you're searching on all projects and voila you have multi-project searches. You can save the results as a filter and run stats on it. This is not perfect and does not handle project level custom fields ideally. However, for all those people craving multi-project searching, this hopefully will ease the pain quite a bit.

Will this work for pre 3.2 versions of JIRA?}

The short answer is no, but it would be possible to write your own custom field type that mimics what the "Dummy Project Field". Which is pretty much do nothing for anything apart from getValueFromIssue where it returns the projectId. Retrofit the searcher, and the search template to the 3.0.3 code base and you should also be able to have your own multi-project searcher.

Open Issues

type key summary reporter status

Unable to locate JIRA server for this macro. It may be due to Application Link configuration.

Screenshots