Book Image

JIRA Development Cookbook

Book Image

JIRA Development Cookbook

Overview of this book

JIRA provides issue tracking and project tracking for software development teams to improve code quality and the speed of development.This book is your one-stop resource to master JIRA extension and customization. You will learn how to create your own JIRA plugins, customize the look and feel of your JIRA UI, work with Workflows, Issues, Custom Fields, and much more.The book starts with recipes on simplifying the Plugin development process followed by a complete chapter dedicated to the Plugin Framework to master Plugins in JIRA.Then we will move on to writing custom field plugins to create new field types or custom searchers. We then learn how to program and customize Workflows to transform JIRA into a user-friendly system. Reporting support in an application like JIRA is inevitable! With so much data spanning across different projects, issues, etc and a lot of project planning done on it, we will cover how to work on reports and gadgets to get customized data according to our needs. We will then look at customizing the various searching aspects of JIRA such as JQL, searching in plugins, managing filters, and so on. Then the book steers towards programming Issues, i.e. creating/editing/deleting issues, creating new issue operations, managing the various other operations available on issues via the JIRA APIs etc. In the latter half of the book, you will learn how to customize JIRA by adding new tabs, menus, and web items, communicate with JIRA via the REST, SOAP or XML/RPC interfaces, and work with the JIRA database.The book ends with a chapter on useful and general JIRA recipes.

Related Content you might be interested in

Current Title:

Small book image
JIRA Development Cookbook
Nov, 2011 | 476 pages
No titles found
Table of Contents (19 chapters)
JIRA Development Cookbook
JIRA Development Cookbook
Credits
Credits
About the Author
About the Author
Acknowledgment
Acknowledgment
About the Reviewers
About the Reviewers
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Plugin Development Process
Plugin Development Process
Introduction
Setting up the development environment
Creating a skeleton plugin
Deploying a plugin
Making changes and re-deploying a plugin
Testing and debugging
2
Understanding Plugin Framework
Understanding Plugin Framework
Introduction
Converting plugins from v1 to v2
Adding resources into plugins
Adding web resources into plugins
Building JIRA from source
Adding new webwork actions to JIRA
Extending a webwork action in JIRA
3
Working with Custom Fields
Working with Custom Fields
Introduction
Writing a simple custom field
Custom field searchers
Dealing with custom fields on an issue
Programming custom field options
Overriding validation of custom fields
Customizing the change log value
Migrating from one custom field type to another
Making custom fields sortable
Displaying custom fields on subtask columns
User and date fields from 4.1.x
Adding custom fields to notification mails
Adding help text for a custom field
Removing the 'none' option from a select field
Making the custom field project importable
Changing the size of a text area custom field
4
Programming Workflows
Programming Workflows
Introduction
Writing a workflow condition
Writing a workflow validator
Writing a workflow post function
Editing an active workflow
Making an issue editable/non-editable based on workflow status
Including/excluding resolutions for specific transitions
Permissions based on workflow status
Internationalization in workflow transitions
Obtaining available workflow actions programmatically
Programmatically progressing on workflows
Obtaining workflow history from the database
Re-ordering workflow actions in JIRA
Creating common transitions in workflows
Jelly escalation
5
Gadgets and Reporting in JIRA
Gadgets and Reporting in JIRA
Introduction
Writing a JIRA report
Reports in Excel format
Data validation in JIRA reports
Restricting access to reports
Object configurable parameters for reports
Creating a pie chart in JIRA
Writing JIRA 4 gadgets
Invoking REST services from gadgets
Configuring user preferences in gadgets
Accessing gadgets outside of JIRA
6
The Power of JIRA Searching
The Power of JIRA Searching
Introduction
Writing a JQL function
Sanitizing JQL functions
Adding a search request view
Smart querying using quick search
Searching in plugins
Parsing a JQL query in plugins
Linking directly to search queries
Index and de-index programmatically
Managing filters programmatically
Subscribing to a filter
7
Programming Issues
Programming Issues
Introduction
Creating an issue from a plugin
Creating subtasks on an issue
Updating an issue
Deleting an issue
Adding new issue operations
Conditions on issue operations
Working with attachments
Time tracking and worklog management
Working with comments on issues
Programming Change Logs
Programming issue links
Validations on issue linking
Discarding fields while cloning
JavaScript tricks on issue fields
8
Customizing the UI
Customizing the UI
Introduction
Changing the basic look and feel
Adding new web sections in the UI
Adding new web items in the UI
Adding conditions for web fragments
Creating new velocity context for web fragments
Adding a new drop-down menu on the top navigation bar
Dynamic creation of web items
Adding new tabs in the View Issue screen
Adding new tabs in the Browse Project screen
Creating Project Tab Panel using fragments
Adding new tabs in the Browse Version screen
Adding new tabs in the Browse Component screen
Extending a webwork action to add UI elements
Displaying dynamic notifications/warnings on issues
Re-ordering Issue Operations in the View Issue page
Re-ordering fields in the View Issue page
9
Remote Access to JIRA
Remote Access to JIRA
Introduction
Creating a SOAP client
Creating an issue via SOAP
Working with custom fields and SOAP
Attachments and SOAP
Worklogs and time tracking via SOAP
Commenting on an issue via SOAP
User and group management via SOAP
Progressing an issue in workflow using SOAP
Managing versions via SOAP
Administration methods in SOAP API
Deploy a SOAP service in JIRA
Deploy a XML-RPC service within JIRA
Writing a Java XML-RPC client
Expose services and data entities as REST APIs
Writing Java client for REST API
10
Dealing with a Database
Dealing with a Database
Introduction
Extending JIRA DB with custom schema
Accessing DB entities from plugins
Persisting plugin information in JIRA DB
Using active objects to store data
Accessing JIRA configuration properties
Getting database connection for JDBC calls
Migrating a custom field from one type to another
Retrieving issue information from a Database
Retrieving custom field details from a database
Retrieving permissions on issues from a database
Retrieving workflow details from a database
Updating issue status in a database
Retrieving users and groups from a database
Dealing with Change history in a database
11
Useful Recipes
Useful Recipes
Introduction
Writing a service in JIRA
Adding configurable parameters to a service
Writing scheduled tasks in JIRA
Writing listeners in JIRA
Customizing e-mail content
Redirecting to different page in webwork actions
Adding custom behavior for user details
Deploying a servlet in JIRA
Adding shared parameters to Servlet Context
Writing a Servlet Context Listener
Using filters to intercept queries in JIRA
Adding and importing components in JIRA
Adding new module types to JIRA
Enabling access logs in JIRA
Enabling SQL logging in JIRA
Overriding JIRA's default components in plugins
Creating issues and comments from e-mail
Internationalization in webwork plugins
Sharing common libraries across v2 plugins
Operations using direct HTML links
Index
Index

Reports in Excel format

In the previous recipe, we saw how to write a simple report. We will now see how to modify the report plugin to include Excel reports.

Getting ready

Create the report plugin, as mentioned in the previous recipe.

How to do it...

The following are the steps to include the provision of exporting the report to Excel.

  1. Add the velocity resource type for the Excel view in the plugin descriptor if not added already:

    <resource type="velocity" name="excel" location="templates/allissues/allissues-report-excel.vm" />

  2. Override the isExcelViewSupported method in the report class to return true. In our case, we add this in the AllIssuesReport.java:

    @Override
public boolean isExcelViewSupported() {
  return true;
}

    This method returns false by default, as it is implemented that way in the AbstractReport class.

  3. Override the generateReportExcel method returning the Excel view. This is very similar to the generateReportHtml we implemented in the previous recipe. The only difference is the...

Previous Section
End of Section 4
Next Section