Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying JIRA Development Cookbook
  • Table Of Contents Toc
JIRA Development Cookbook

JIRA Development Cookbook - Third Edition

4.7 (3)
Buy this Book
close
close
JIRA Development Cookbook

JIRA Development Cookbook

4.7 (3)
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.
Table of Contents (12 chapters)
close
close
close
Preface
Icon
Preface
Icon
What this book covers
Icon
What you need for this book
Icon
Who this book is for
Icon
Sections
Icon
Conventions
Icon
Reader feedback
Icon
Customer support
Lock Free Chapter
1
1. Plugin Development Process
Icon
1. Plugin Development Process
Icon
Introduction
Icon
Setting up the development environment
Icon
Creating a skeleton plugin
Icon
Adding plugin modules
Icon
Deploying a JIRA plugin
Icon
Making changes and redeploying a plugin
Icon
Using FastDev for plugin development
Icon
Testing and debugging
2
2. Understanding the Plugin Framework
Icon
2. Understanding the Plugin Framework
Icon
Introduction
Icon
Modifying Atlassian bundled plugins
Icon
Converting plugins from V1 to V2
Icon
Adding resources into plugins
Icon
Adding web resources into plugins
Icon
Building JIRA from source
Icon
Adding new webwork actions to JIRA
Icon
Form token handling in webwork actions
Icon
Capturing plugin installation/uninstallation events
3
3. Working with Custom Fields
chevron up
Icon
3. Working with Custom Fields
Icon
Introduction
Icon
Writing a simple custom field
Icon
Custom field searchers
Icon
Dealing with custom fields on an issue
Icon
Programming custom field options
Icon
Overriding the validation of custom fields
Icon
Customizing the change log value
Icon
Migrating from one custom field type to another
Icon
Making custom fields sortable
Icon
Displaying custom fields on subtask columns
Icon
User and date fields
Icon
Adding custom fields to notification e-mails
Icon
Adding help text for a custom field
Icon
Removing the "none" option from a select field
Icon
Making the custom field project importable
Icon
Changing the size of a text area custom field
4
4. Programming Workflows
Icon
4. Programming Workflows
Icon
Introduction
Icon
Writing a workflow condition
Icon
Writing a workflow validator
Icon
Writing a workflow post function
Icon
Editing an active workflow
Icon
Permissions based on workflow status
Icon
Including/excluding resolutions for specific transitions
Icon
Adding workflow triggers
Icon
Internationalization in workflow statuses
Icon
Obtaining available workflow actions programmatically
Icon
Programmatically progressing on workflows
Icon
Obtaining workflow history from the database
Icon
Reordering workflow actions in JIRA
Icon
Creating common transitions in workflows
Icon
Creating global transitions in workflows
5
5. Gadgets and Reporting in JIRA
Icon
5. Gadgets and Reporting in JIRA
Icon
Introduction
Icon
Writing a JIRA report
Icon
Reports in Excel format
Icon
Data validation in JIRA reports
Icon
Restricting access to reports
Icon
Object configurable parameters for reports
Icon
Writing JIRA gadgets
Icon
Invoking REST services from gadgets
Icon
Configuring user preferences in gadgets
Icon
Accessing gadgets outside of JIRA
6
6. The Power of JIRA Searching
Icon
6. The Power of JIRA Searching
Icon
Introduction
Icon
Writing a JQL function
Icon
Sanitizing JQL functions
Icon
Adding a search request view
Icon
Smart querying using quick search
Icon
Searching in plugins
Icon
Parsing a JQL query in plugins
Icon
Linking directly to search queries
Icon
Index and de-index issues programmatically
Icon
Searching on issue entity properties
Icon
Managing filters programmatically
Icon
Subscribing to a filter
7
7. Programming Issues
Icon
7. Programming Issues
Icon
Introduction
Icon
Creating an issue from a plugin
Icon
Creating subtasks on an issue
Icon
Updating an issue
Icon
Deleting an issue
Icon
Adding new issue operations
Icon
Conditions on issue operations
Icon
Working with attachments
Icon
Time tracking and worklog management
Icon
Working with comments on issues
Icon
Programming change logs
Icon
Programming issue links
Icon
JavaScript tricks on issue fields
Icon
Creating issues and comments from e-mail
8
8. Customizing the UI
Icon
8. Customizing the UI
Icon
Introduction
Icon
Changing the basic look and feel
Icon
Adding new web sections in the UI
Icon
Adding new web items in the UI
Icon
Use of decorators and other metadata tags
Icon
Adding conditions for web fragments
Icon
Creating new velocity context for web fragments
Icon
Adding a new drop-down menu on the top navigation bar
Icon
Dynamic creation of web items
Icon
Adding new tabs in the View Issue screen
Icon
Adding new tabs in the Browse Project screen
Icon
Adding new links in the Project-centric view
Icon
Adding new panels in the project-centric view
Icon
Adding sub-navigation in Project-centric view
Icon
Adding issue link renderers
Icon
Displaying dynamic notifications/warnings on issues
Icon
Re-ordering Issue Operations in the View Issue page
Icon
Re-ordering fields in the View Issue page
9
9. Remote Access to JIRA
Icon
9. Remote Access to JIRA
Icon
Introduction
Icon
Writing Java client for REST API
Icon
Working with issues
Icon
Working with attachments
Icon
Remote time tracking
Icon
Working with comments
Icon
Remote user and group management
Icon
Progressing an issue in workflow
Icon
Searching issues
Icon
Managing versions
Icon
Managing components
Icon
Remote administration methods
Icon
Exposing services and data entities as REST APIs
Icon
Using the REST API browser
Icon
Working with JIRA Webhooks
10
10. Dealing with the JIRA Database
Icon
10. Dealing with the JIRA Database
Icon
Introduction
Icon
Extending the JIRA database with a custom schema
Icon
Accessing database entities from plugins
Icon
Persisting plugin information in the JIRA database
Icon
Using Active Objects to store data
Icon
Accessing the JIRA configuration properties
Icon
Getting a database connection for JDBC calls
Icon
Migrating a custom field from one type to another
Icon
Retrieving issue information from a database
Icon
Retrieving custom field details from a database
Icon
Retrieving permissions on issues from a database
Icon
Retrieving workflow details from a database
Icon
Updating the issue status in a database
Icon
Retrieving users and groups from a database
Icon
Dealing with change history in a database
11
11. Useful Recipes
Icon
11. Useful Recipes
Icon
Introduction
Icon
Writing a service in JIRA
Icon
Adding configurable parameters to a service
Icon
Writing scheduled tasks in JIRA
Icon
Writing listeners in JIRA
Icon
Customizing e-mail content
Icon
Redirecting to a different page in webwork actions
Icon
Adding custom behavior for user details
Icon
Deploying a servlet in JIRA
Icon
Adding shared parameters to Servlet Context
Icon
Writing a Servlet Context Listener
Icon
Using filters to intercept queries in JIRA
Icon
Adding and importing components in JIRA
Icon
Adding new module types to JIRA
Icon
Enabling access logs in JIRA
Icon
Enabling SQL logging in JIRA
Icon
Internationalization in webwork plugins
Icon
Sharing common libraries across v2 plugins
Icon
Operations using direct HTML links
Icon
Implementing Marketplace licensing in plugins

Programming custom field options

We have seen how to create a custom field type, search for it, and read/update its value from/on an issue. But one important aspect of multi-valued custom fields, and one that we haven't seen yet, is custom field options.

On a multi-valued custom field, the administrator can configure the allowed set of values, also called options. Once the options are configured, users can only select values within that set of options, and validation is done to ensure that this is the case.

So, how do we programmatically read those options, or add a new option to the custom field so that it can be later set on an issue? Let us have a look at that in this recipe.

Getting ready

Create a multivalued custom field, say X, in your JIRA instance. Add a few options to the field X.

How to do it...

To deal with custom field options, Atlassian has written a manager class named OptionsManager.

Here are the steps to get the options configured for a custom field:

  1. Get an instance of the...
CONTINUE READING
83
Tech Concepts
36
Programming languages
73
Tech Tools
Icon Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.
Icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Icon 50+ new titles added per month and exclusive early access to books as they are being written.
JIRA Development Cookbook
End of Section 3
Next Section
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon