JIRA

Install

Admin

Use

	JIRA Administrator's Guide Introduction Getting Help Look and Feel Logo, Colours and Time Formats Configuring the default Language Configuring the default Issue Navigator Configuring the default Dashboard Overview of Dashboard Portlets Preinstalled portlets Extension portlets Creating New 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 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 Restoring a Project Database Integrity Checker Increasing memory Performance Tips Database Indexing Precompile JSP pages Logging and Profiling Thread Dump 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

JIRA Portlets

PDF

JIRA provides the ability to display summary information on project/issue data through the use of portlets. Each portlet can be configured to display project and issue details relevant to particular users. Portlets can be added to the dashboard - providing a central location for quick access to this information.

Preinstalled portlets

JIRA provides a set of standard portlets out-of-the-box:

Portlet	Description
Administration Portlet	The Administration portlet displays quick links to administrative functions conveniently on the dashboard.
Assigned To Me Portlet	The Assigned To Me portlet displays all open issues in all projects assigned to the current user viewing the dashboard.
Bugzilla ID Search Portlet	The Bugzilla ID Search portlet allows the user to search all JIRA issues for references to Bugzilla IDs.
Favourite Filters Portlet	The Favourite Filters portlet displays a list of all the issue filters that have currently been added by you as a favourite filter.
Filter Statistics Portlet	The Filter Statistics portlet displays the collection of issues returned from a specified filter broken down by a specified field.
2D Filter Statistics Portlet	The Two Dimensional Filter Statistics portlet displays statistical data based on a specified filter in a configurable table format.
In Progress Portlet	The In Progress portlet displays all issues that are currently in progress and assigned to the current user viewing the dashboard.
Introduction Portlet	The Introduction portlet displays a configurable introduction message on the dashboard.
Project Portlet	The Project portlet provides information and various filters related to a specified project on the dashboard.
Projects Portlet	The Projects portlet provides information and various filters related to all projects within JIRA.
Project Statistics Portlet	The Project Statistics portlet allows various per-project statistical data to be displayed on the dashboard.
Project Table Portlet	The Project Table portlet displays all the project names in a table in the dashboard.
Quick Links Portlet	The Quick Links portlet displays a number of useful links to issues associated with the current user. Each link directs the user to the Issue Navigator, displaying the relevant issues such as Reported Issues, Voted Issues and Watched Issues.
Road Map Portlet	The Road Map portlet shows versions which are due for release within a specified period of time, and a summary of progress made towards completing the issues in those versions.
Saved Filter Portlet	The Saved Filter portlet displays the results of a specified issue filter on the dashboard.
Text Portlet	The Text portlet displays a configurable HTML text on the dashboard.
Voted Portlet	The Voted Issues portlet shows issues for which you have voted.
Watched Portlet	The Watched Issues portlet shows issues which you are watching.

Extension portlets

Other portlets are available as plugins on the JIRA Extensions site. These plugins include:

Should you wish to you use these plugins, you need to first install them (using the instructions provided with each plugin) then enable them.

Creating New 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. Many sample portlets, including source, are available in the JIRA Extensions space.