JIRA Development Cookbook: Develop and customize plugins, program workflows, work on custom fields, master JQL functions, and more to effectively customize, manage, and extend JIRA

€35.98 ~~€39.99~~

4.7 (7 Ratings)

eBook Nov 2011 476 pages 1st Edition

€35.98 ~~€39.99~~

eBook Nov 2011 476 pages 1st Edition

What do you get with eBook?

Instant access to your Digital eBook purchase

Download this book in EPUB and PDF formats

Access this title in our online reader with advanced features

DRM FREE - Read whenever, wherever and however you want

View table of contents

Preview Book

JIRA Development Cookbook

Chapter 2. Understanding Plugin Framework

In this chapter, we will see more details on the JIRA Architecture and the plugin framework. We will also see the following recipes:

Converting plugins from v1 to v2
Adding resources into plugins
Adding web resources to the plugin
Building JIRA from source
Adding new webwork actions to JIRA
Extending a webwork action in JIRA

Adding resources into plugins

It is often required to add static resources like JavaScript files, CSS files, and so on in our plugins. To enable JIRA to serve these additional static files, they should be defined as downloadable resources.

Getting ready

A resource can be of different types. It is normally defined as a non-Java file that the plugin requires to operate.

Examples of resources that you will come across during JIRA plugin development include, but are not restricted to, the following:

Velocity (*.vm) files required to render a view
JavaScript files
CSS files
Property files for localization

How to do it...

To include a resource, add the resource module to the atlassian-plugin.xml file. The resource module can be added as part of the entire plugin or can be included within another module, restricting it just for that module.

The following are the attributes and elements available for the resource module and their uses:

Name	Description
`name`	Name of the resource. This is used by the plugin...

Adding web resources into plugins

The web resources plugin module, like the resource module we just saw, allows defining downloadable resources. The difference is that the web resources are added at the top of the page in the header with the cache-related headers set to never expire.

An additional advantage of using web resources module is that we can specify the resources to be included in specific contexts within the application.

How to do it...

The root element for the web resource plugin module is web-resource. It supports the following attributes:

Name	Description
`Key`	The only mandatory attribute. This should be unique within the plugin.
`Disabled`	Indicates whether the plugin module should be disabled by default or not.
`i18n-name-key`	The localization key for the human-readable name of the plugin module.
`Name`	Human-readable name of the web resource.

The following are the key elements supported.

Name	Description
`description`	Description of the module.
`resource`	All the resources...

Adding new webwork actions to JIRA

Most of the time plugin developers will find themselves writing new actions in JIRA to introduce new functionality. Usually these actions are invoked from new web-item links configured at different places in the UI. It could also be from customized JSPs or other parts of the JIRA framework.

New actions can be added to JIRA with the help of the webwork plugin module.

Getting ready

Before we start, it probably makes sense to have a look at the webwork plugin module. Following are the key attributes supported:

Name	Description
`Key`	A unique key within the plugin. It will be used as the identifier for the plugin.
`Class`	This will be `java.lang.Object` as the real logic will reside in the action, Class.
`i18n-name-key`	The localization key for the human-readable name of the plugin module.
`Name`	Human-readable name of the webwork action.

The following are the key elements supported:

Name	Description
`description`	Description of the webwork module.
`actions`	...

Key benefits

Extend and Customize JIRA--Work with custom fields, workflows, Reports & Gadgets, JQL functions, plugins, and more
Customize the look and feel of your JIRA User Interface by adding new tabs, web items and sections, drop down menus, and more
Master JQL - JIRA Query Language that enables advanced searching capabilities through which users can search for issues in their JIRA instance and then exploit all the capabilities of issue navigator
Part of Packt's Cookbook series: Each recipe is a carefully organized sequence of instructions to complete the task as efficiently as possible

Description

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.

Who is this book for?

If you are a JIRA developer or project manager who wants to fully exploit the exciting capabilities of JIRA, then this is the perfect book for you.

What you will learn

Create and deploy your own JIRA plugins
Deal with Custom Fields on an Issue and program Custom Field Options
Program and customize Workflows to transform JIRA into a user-friendly system
Create reports that show statistics for particular people, projects, versions, or other fields within issues
Simplify reporting by writing your own JIRA Gadgets, which can be added into a user s dashboard
Create, edit, and delete Issues
Master Database handling in JIRA --retrieve Issue information from Database, extend the database, retrieve Custom Field details from the database, access database entities from plugins, and more
Communicate with JIRA via the REST, SOAP or XML/RPC interfaces

What do you get with eBook?

Instant access to your Digital eBook purchase

Download this book in EPUB and PDF formats

Access this title in our online reader with advanced features

DRM FREE - Read whenever, wherever and however you want

Frequently bought together

€41.99

€48.99

€53.99

Total € 144.97

Filter reviews by

All

Amazon verified reviews

Amazon Customer Jan 22, 2012

This book shows the power of JIRA, the best plugin book yet by far from one of the best plugin developers and his company are leaders in JIRA Plugins.Also interesting to see the power of JIRA and why it is taking over the industry! Look out, these products are industry changers and the prices for the products and services have set the status quo up side down!One thing I would like to see, it seems Jobin and his company are using a new style of plugin development, basically a cloud based integration for entire systems instead of traditional point to point solutions they call the product ConnectAll. This book came out before their new ConnectAll plugin. I wish it had covered this approach!

Amazon Verified review

LB Jun 13, 2012

I saw this book displayed on one of the vendor stations at the recent Atlassian Summit. After perusing the table of contents, it looked like something that I needed to bring back to my company. Two days after the book arrived there were two V.P.'s and a Director 'fighting' over it and they've already generated query results that have resulted in some process changes and planning decisions. I have ordered 3 additional copies.

EMC Feb 02, 2012

An excellent book about JIRA plugin development written for programmers by a programmer. The book is extensive, well organized, homogeneous and very effective. The author guides you through the subject from the initial setup of the development environment, describing the most important JIRA APIs to extend and customize the JIRA behavior, including advanced topics such as JQL customization and the extension of the JIRA database schema. The book also covers in detail the customization process of the JIRA user interface and the integration of JIRA with third party systems using web services (SOAP, RESTful and JAX-RPC). A must-have for a JIRA plugin developer.If you're interested about a more in-depth review of this book, I wrote a post about it in my blog (<...>).

Modha Jan 05, 2012

JIRA Development Cookbook is a good book to start learning JIRA plugin development. Content is very well organized and simple to understand examples. Chapters are self contained and cover every aspect of JIRA plugin development and are not presented in overtly technical manner. If you are a plugin guru this book is not for you, but if you are newbie it is worth your money.

Akila Ramanathan Jan 16, 2012

If you want to develop Jira as a business system that can almost do anything, get this book to know the nuts and bolts of Jira development.All the chapters were self sufficient and if you are a Jira Admin - this book is for you.-Srini

JIRA Development Cookbook: Develop and customize plugins, program workflows, work on custom fields, master JQL functions, and more to effectively customize, manage, and extend JIRA

What do you get with eBook?

JIRA Development Cookbook

Chapter 2. Understanding Plugin Framework

Introduction

JIRA Architecture

Converting plugins from v1 to v2

Getting ready

Adding resources into plugins

Getting ready

How to do it...

Adding web resources into plugins

How to do it...

Building JIRA from source

Getting ready

Note

How to do it...

Adding new webwork actions to JIRA

Getting ready

Extending a webwork action in JIRA

How to do it...

Page 1 of 8

Key benefits

Description

Who is this book for?

What you will learn

Product Details

What do you get with eBook?

Product Details

Frequently bought together

Table of Contents

Recommendations for you

Customer reviews

Filter reviews by

People who bought this also bought

FAQs

JIRA Development Cookbook: Develop and customize plugins, program workflows, work on custom fields, master JQL functions, and more to effectively customize, manage, and extend JIRA

What do you get with eBook?

Contact Details

Billing Address

Key benefits

Description

Who is this book for?

What you will learn

Product Details

What do you get with eBook?

Contact Details

Billing Address

Product Details

Packt Subscriptions

Frequently bought together

Table of Contents

Recommendations for you

Customer reviews

Filter reviews by

People who bought this also bought

FAQs