JIRA Development Cookbook

JIRA Development Cookbook - Third Edition

By : Jobin Kuruvilla

Buy this Book

JIRA Development Cookbook - Third Edition

By: Jobin Kuruvilla

Buy this Book

Overview of this book

JIRA provides issue and project tracking for software development teams to improve code quality and the speed of development. With the new version of JIRA, you can create your own JIRA plugins and customize the look and feel of your JIRA UI easier than ever. JIRA Development Cookbook , Third Edition, is a one-stop resource to master extensions and customizations in JIRA. This book starts with recipes about simplifying the plugin development process followed by recipes dedicated to the plugin framework. Then, you will move on to writing custom field plugins to create new field types or custom searchers. You will also learn how to program and customize workflows to transform JIRA into a user-friendly system. With so much data spanning different projects, issues, and so on, we will cover how to work on reports and gadgets to get customized data according to our needs. At the end of the book, you will learn how to customize JIRA by adding new tabs, menus, and web items; communicate with JIRA via the REST APIs; and work with the JIRA database.

JIRA Development Cookbook Third Edition

Credits

About the Author

Acknowledgments

About the Reviewer

www.PacktPub.com

Preface

Free Chapter

Plugin Development Process

Introduction

Setting up the development environment

Creating a skeleton plugin

Adding plugin modules

Deploying a JIRA plugin

Making changes and redeploying a plugin

Using FastDev for plugin development

Testing and debugging

Understanding the Plugin Framework

Introduction

Modifying Atlassian bundled plugins

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

Form token handling in webwork actions

Capturing plugin installation/uninstallation events

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 the 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

Adding custom fields to notification e-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

Programming Workflows

Introduction

Writing a workflow condition

Writing a workflow validator

Writing a workflow post function

Editing an active workflow

Permissions based on workflow status

Including/excluding resolutions for specific transitions

Adding workflow triggers

Internationalization in workflow statuses

Obtaining available workflow actions programmatically

Programmatically progressing on workflows

Obtaining workflow history from the database

Reordering workflow actions in JIRA

Creating common transitions in workflows

Creating global transitions in workflows

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

Writing JIRA gadgets

Invoking REST services from gadgets

Configuring user preferences in gadgets

Accessing gadgets outside of JIRA

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 issues programmatically

Searching on issue entity properties

Managing filters programmatically

Subscribing to a filter

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

JavaScript tricks on issue fields

Creating issues and comments from e-mail

Customizing the UI

Introduction

Changing the basic look and feel

Adding new web sections in the UI

Adding new web items in the UI

Use of decorators and other metadata tags

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

Adding new links in the Project-centric view

Adding new panels in the project-centric view

Adding sub-navigation in Project-centric view

Adding issue link renderers

Displaying dynamic notifications/warnings on issues

Re-ordering Issue Operations in the View Issue page

Re-ordering fields in the View Issue page

Remote Access to JIRA

Introduction

Writing Java client for REST API

Working with issues

Working with attachments

Remote time tracking

Working with comments

Remote user and group management

Progressing an issue in workflow

Searching issues

Managing versions

Managing components

Remote administration methods

Exposing services and data entities as REST APIs

Using the REST API browser

Working with JIRA Webhooks

Dealing with the JIRA Database

Introduction

Extending the JIRA database with a custom schema

Accessing database entities from plugins

Persisting plugin information in the JIRA database

Using Active Objects to store data

Accessing the JIRA configuration properties

Getting a 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 the issue status in a database

Retrieving users and groups from a database

Dealing with change history in a database

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 a 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

Internationalization in webwork plugins

Sharing common libraries across v2 plugins

Operations using direct HTML links

Implementing Marketplace licensing in plugins

Customer Reviews

5 star

4 star

3 star

2 star

1 star

Extending the JIRA database with a custom schema

Now that we know that JIRA schema definitions are maintained in WEB-INF/classes/ entitydefs/entitygroup.xml and entitymodel.xml, let us have a look at extending the existing schema definitions. How would you extend the JIRA scheme if you wanted to add one or two custom tables into JIRA? Is it just about creating the new tables in our database? We will see that in this recipe.

Note

For plugins, it is recommended to use Active Objects technology to persist data. The JIRA schema itself should be modified only when it is absolutely necessary to have pre-defined tables created in the JIRA database.

If the JIRA schema is modified, care must be taken during upgrades to port those changes to the new version.

How to do it...

JIRA uses the schema definitions entered in the WEB-INF/classes/entitydefs/ entitygroup.xml and entitymodel.xml files. It makes use of these files not only to validate and create the schema but also during the import and export of the...

JIRA Development Cookbook - Third Edition

By : Jobin Kuruvilla

JIRA Development Cookbook - Third Edition

By: Jobin Kuruvilla

Overview of this book

Related Content you might be interested in

Current Title:

JIRA Development Cookbook - Third Edition

Extending the JIRA database with a custom schema

Note

How to do it...