JIRA

Install

Admin

Use

	JIRA Administrator's Guide Introduction Getting Help Look and Feel Logo, Colours and Timezone Configuring the default Language Configuring the default Issue Navigator Configuring the default Dashboard Overview of Dashboard Portlets Enabling Portlets and Other Plugins Editing the Announcement Banner Enabling Logout Confirmation Email Email Overview Creating a Notification Scheme Customising Email Content Creating Issues & Comments from Email SMTP configuration User Management Managing Users Managing Groups Managing Project Roles Migrating from Groups to Project Roles Enabling public signup and CAPTCHA Integrating JIRA with LDAP Integrating JIRA with Crowd Configuring Trusted Applications Security Overview Global permissions Project permissions Issue security Project Management Defining a Project Assigning members to Project Roles Defining Project Components Defining Project Versions Creating Release Notes for a Version Configuring Project Keys Configuring Fields and Screens Overview Defining 'Resolution' field values Defining 'Priority' field values Defining 'Status' field values Defining 'Issue Type' field values Associating Issue Types with Projects Translating Resolution/Priority/Status/Type Configuring field behaviour Configuring rich-text renderers Associating behaviour with Issue Types Placing fields on screens Associating screens with Issue Operations Associating screens with Issue Types Creating & configuring Custom Fields Custom Field Overview Adding Custom Fields Configuring Custom Fields Configuring Workflow Workflow Activating Workflow Events Importing from Other Systems Importing from Bugzilla Importing from Mantis Importing from FogBugz Importing from Excel/CSV Moving or Archiving Individual Projects Overview Archiving a project Merging JIRA instances Splitting JIRA instances Integrating with Source Control Integrating with CVS and ViewCVS Integrating with Subversion Integrating with Perforce Integrating with ClearCase Integrating with FishEye Configuration Options & Settings Global Settings Enabling Issue Linking Enabling Sub-tasks Enabling Trackback linking Enabling Time Tracking Enabling File Attachments Enabling Thumbnails for Attachments Server Administration Indexing & Search Backing up Data Automated Backups Restoring Data Database Integrity Checker Increasing memory Performance Tips Database Indexing Precompile JSP pages Logging and Profiling Thread Dump Downgrading (Ent to Pro) Downgrading (Ent to Std) Downgrading (Pro to Std) Using robots.txt with Search Engines Appendix A - Extending JIRA Extension Overview Listeners Services Jelly tags JIRA Toolkit Customising Text Developer Guides JIRA Plugins JIRA RPC Overview Creating a SOAP Client Creating an XML-RPC Client Creating Custom Field Types Custom Workflow Elements Creating new Portlets Creating new Reports More.. JIRA Source Building JIRA from source API Documentation

Extending JIRA

PDF

JIRA is very flexible, and has a number of extension points where JIRA's data can be queried or its functionality extended. You can also download the JIRA Plugin Development Kit. This contains full source code for seven working plugins (and growing), skeleton project templates for creating your own plugins, full JIRA API documentation and all library dependencies.

Custom Field Types	JIRA comes with various custom field types defined. New types can be written and plugged into JIRA. See the Writing Custom Field Types Tutorial for more information.
Portlets	New portlets can be created by writing a Java class, a template and an XML descriptor file, packaged as a JIRA plugin. See How To Create a JIRA Portlet for more information.
Reports	JIRA comes with various reports built-in. Using the plugin system, new reports can be written, providing new ways of viewing and summarising JIRA's data.
Workflow functions and conditions	JIRA's issue workflow (states and state transitions an issue can go through) can be customized through the web interface (see the workflow documentation. The workflow engine (OSWorkflow) provides hooks where you can plug in your own behaviour: Run arbitrary Java when a certain transition occurs, via post-functions Limit visibility of transitions to certain users, via conditions Validate input on transition screens (eg. in comments), via validators See the guide to creating custom workflow elements for how to write your own workflow post-functions, conditions and validators. Once written, these can be packaged as plugins and reused.
Issue and Project Tabs	When viewing an issue, some issue information (comments, change history) is displayed in tabs: Likewise, the 'Browse Project' page contains tab panels displaying project information: By writing a plugin, you can add new issue or project tab panels to JIRA. For instance, you may wish to display project/issue data pulled in from an external source. This is how JIRA's Subversion and Perforce integration works. See the plugin guide for more information on writing these plugin types.
Listeners	JIRA has a complete event subsystem which fires events whenever anything happens. For example an ISSUE_CREATED event is fired whenever an issue is created. A listener is just a class which implements a JiraListener interface and is called whenever events occur in JIRA. Using those events, you can then perform any action you want. For example the email sent by JIRA is driven by the MailListener. This is useful when you want to drive or affect external systems from events which occur within JIRA - usually used to push data into outside systems. For more information, read the listeners documentation.
Services	Services are classes which implement the JiraService interface. When installed, you specify an update period and JIRA will call the run() method of your service periodically. A sample service is provided called POPCommentService. This service checks a particular POP mailbox periodically and if it finds messages, tries to extract an issue key from the subject. If the subject contains a key, the body of the mail is added as a comment to the message. Services are useful when you want to periodically pull data into JIRA from outside systems. For more information, see the services guide.
SOAP and XML-RPC remote interfaces	JIRA has a growing SOAP and XML-RPC interface. This enables you to drive JIRA automatically from external systems. For example you can have a Java program, Perl script or C# client add issues to JIRA. See the JIRA RPC overview for general information. For building RPC clients, check out the SOAP client tutorial and XML-RPC client tutorial. New RPC endpoints can also be added to JIRA as plugins - see RPC Endpoint Plugins.
Java	JIRA has a full set of Java APIs that can be used to update information with in JIRA. You can view the API here. JIRA commercial customers get full access to the JIRA source (see bottom of the downloads page), so you can modify JIRA itself if necessary. See the Building JIRA from Source page for more information.