JIRA
Install
Admin
Use
Search JIRA documentation:

Configuring the Dashboard

PDF
PDF

The Dashboard is the first page you see when you login to JIRA. It can be configured to display many different types of information, depending on your areas of interest.

The information boxes on the dashboard page are called Portlets:

Dashboard Portlets

You can configure your dashboard by re-ordering the portlets, and moving them between the left and right columns; and some portlets can themselves be configured. You can also add other portlets to your dashboard page, and even create more pages for your dashboard (if you are using the Professional or Enterprise edition of JIRA).

Available portlets include:

*This portlet will only be available if it has been installed by your JIRA administrator.

Steps to configure the dashboard

In JIRA 3 there are two ways to configure your dashboard:

  1. Using the configuration interface. The interface only shows the name of the portlets and their position on a dashboard page. You can use the configuration interface to quickly move portlets around, add and remove portlets or reconfigure them.
  2. Directly from the dashboard, using inline editing. This way you can see exactly how the dashboard page looks current configuration, as the dashboard is completely redrawn with every change. The downside of configuring the dashboard this way, is that if you have configured portlets which take time to load, waiting for the dashboard to render with every change can get a little annoying.
    Note
    This method is only available after the dashboard has been setup for the first time. Please use the first method of configuring the dashboard if your dashboard has not been previously configured.

Using configuration interface

  1. On the top right of the Dashboard, click on the link labelled "Manage Portal".
  2. If you don't currently have a customised dashboard, you will be shown a confirmation page. Click on "Configure Dashboard".
  3. If you are using the Standard edition of JIRA you will be brought to the "Configure Dashboard" page.
    Dashboard configuration page
    If you are using the Professional or the Enterprise edition of JIRA you will be brought to the "Manage Portal" page.
    Portal configuration page
    We will discuss this page in a later section, please click the "Full Configure" link next to the "Dashboard" page in the presented list to proceed to the "Configure Dashboard" page.
  4. The "Configure Dashboard" page consists of two selectable areas listing the portlets. The portlets can be configured as follows:
    Move a portlet up Select the portlet, and click the "^" closest to select area that contains the portlet.
    Move a portlet down Select the portlet, and click the "v" closest to select area that contains the portlet.
    Move a portlet left Select the portlet in the right hand column, and click the "<" button.
    Move a portlet right Select the portlet in the left hand column, and click the ">" button.
    Configure a portlet Select the portlet, and press the "Edit" button.
    Delete a portlet Select the portlet and press the "Delete" button.

In-line Editing

If you have setup a personal dashboard (i.e. are not using the default dashboard) you can configure it without leaving the dashboard page. Simply click the "ON" link next to the "Configure" title in the top-right corner of your dashboard. Each portlet on the dashboard will be highlighted and given a "control" bar with icons that can be used to reorganise the portlets.

In-line Edit screenshot

Please use the left or right icons on a portlet's control bar to move the portlet between columns or the up and down icons to move the portlet up or down within the same column. The curly up and down arrow icons move the portlet to the first or last position in its column. The trash icon removed the portlet from the dashboard page. The wrench icon brings up the "Edit Portlet" page that can be used to edit portlet's parameters. The wrench icon is only available for portlets that have one more customisable parameters.

Adding a Portlet

  1. If you are using the dashboard configuration interface to configure a dashboard page press the "Add" button on the "Configure Dashboard" screen. If you are editing a dashboard page inline, press the "Add new portlet" link in the top-right corner of the dashboard. This page shows you a preview of the available portlets and how much of each already exist on the current dashboard page.
    Add Portlet page
  2. Select the radio button for the portlet you want, and press the "Add" button.
  3. If the portlet you have selected requires configuration, you will be presented with the portlet's configuration page. Configure appropriately and press "Save".
  4. You will be brought back to the page you have started from: either the "Configure Dashboard" page or the dashboard itself.

Statistics Portlets

There are several portlets in JIRA which show useful statistical information. These portlets include:

  1. Project statistics - shows statistics about all issues within a chosen project grouped by a certain issue field (e.g. assignee, reporter, priority).
    Statistic Portlet displaying issues by priority
  2. Filter statistics - very similar to the portlet described above, but uses a saved filter as a source of issues rather than all issue's from a chosen project.
  3. Two Dimensional Filter Statistics - uses a filter as a source of issues and groups the results by two issue fields presenting a matrix with one issue field on the X-axis and another on the Y-axis.
    Statistic Portlet displaying issues by priority and        project

Adding a Page to the Dashboard

The Professional and Enterprise editions of JIRA allow you to configure more than one dashboard page. Each dashboard page can be configured independently, allowing you to neatly organise related information by context.

Each dashboard page appears as a separate "tab" on the dashboard. You can view a dashboard page by simply clicking its name in the tab list.

Dashboard Tabs screenshot

To add a new dashboard page to the dashboard please follow these steps:

  1. On the top right of the Dashboard, click on the link labelled "Manage Portal".
  2. If you don't currently have a customised dashboard, you will be shown a confirmation page. Click on "Configure Dashboard".
  3. If you are using the Professional or the Enterprise edition of JIRA you will be brought to the "Manage Portal" page, which lists all currently configured dashboard pages. The "Manage Portal" page also has a "Add New Portal Page" form at the bottom of the screen.
    Portal configuration page
  4. Provide a name for the new dashboard page and optionally enter a short description. You can also choose an existing page as a starting point for the new page. This means that the configuration of the existing page will be duplicated for the newly created page. Alternatively, if you would like to create a portal page with no portlets, leave the "Blank portal page" option selected.
  5. Click the "Add" button and the new portal page should appear at the bottom of the existing portal pages list.

The "Manage Portal" page also allows you to reorder the dashboard pages and delete them. You can also click the "Full configure" link next to each dashboard page in the list to proceed to the dashboard configuration interface to organise the portlets on that page.