Issue Operations Plugin Module

Added by Mike Cannon-Brookes, last edited by Andrew Lui on May 14, 2008  (view change)
JIRA Documentation

Index

The Issue Operations plugin module allows you to add new operations to the 'View Issue' screen.

Issue Operation plugin modules are available in JIRA 3.4 and later.



You can add new operations with a plugin, linking to information about a single issue (most likely pulled from an external source).

Simple Example

Here is an example descriptor that adds a link to Google a given issue's summary:

<!--
The module class should implement
com.atlassian.jira.plugin.issueoperation.PluggableIssueOperation
-->
<issue-operation key="google-summary" name="Google this issue"
class="com.atlassian.jira.plugin.issueoperation.DefaultPluggableIssueOperation">
<resource type="velocity" name="view">
&lt;img src="$req.contextPath/images/icons/bullet_creme.gif" height=8 width=8 border=0 align=absmiddle&gt;
&lt;b&gt;&lt;a href="http://www.google.com/search?q=${issue.summary}"&gt;Google&lt;/a&gt;&lt;/b&gt; issue summary
</resource>
<!-- the relative order of operations -->
<order>10</order>
</issue-operation>

Issue operations are very useful as a 'hook' to link to your other plugin components - such as Webwork actions, project tab panels, reports etc.

Notes

  • All issue operation classes implements PluggableIssueOperation.
  • The showOperation(Issue issue) method allows you to turn show or hide operations for certain users, permissions etc.
  • DefaultPluggableIssueOperation is a useful base that should work for most simple HTML operations. See for example the Canned Response issue operation plugin
  • The view velocity resource can point to files like other plugins e.g. 
    <resource type="velocity" name="view" location="templates/more-operations.vm"/>
  • All pluggable issue operations occur after system issue operations (i.e. order is among all pluggable operations, not all operations)

Labels:

plugins plugins Delete
operations operations Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.