Configuring the Dashboard
| 
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:
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:
| 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. |
| Bamboo Plan Summary Portlet* | The Bamboo Plan Summary portlet displays a graphical summary of a build plan. |
| Bamboo Status Portlet* | The Bamboo Status portlet displays a list of all plans on the Bamboo server, and each plan's current status. |
| Bugzilla ID Search Portlet | The Bugzilla ID Search portlet allows the user to search all JIRA issues for references to Bugzilla IDs. |
| Charting Portlet* | The Charting portlets display visual representations of a project or a saved filter, in a variety of contexts. |
| Calendar Portlet* | The Calendar portlet shows issues and versions in a calendar format based on their due date. Calendars can be based on an issue filter or on a project. |
| 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. |
*This portlet will only be available if it has been installed by your JIRA administrator.
If you are using the Professional or Enterprise edition of JIRA, you can also set up multiple "dashboard pages"
on your dashboard in individual tabs. Read more about dashboard pages here.
Each dashboard page can be configured independantly, as per the instructions below.
Steps to Configure the Dashboard
In JIRA, there are two ways to configure your dashboard:
-
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.
-
Directly from the dashboard, using inline editing. This way you can
see exactly how the dashboard page looks in the 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.
The first time that you configure your dashboard (by either method), a new dashboard is created for you (based on the
default dashboard) and added as your favourite with private sharing.
Note
If you are using
dashboard pages, you can only configure
dashboard pages that you own. The default '
System Dashboard' can only be
configured by your administrator.
Using the Configuration Interface
- On the top right of the Dashboard, click on the link labelled 'Manage Dashboard'.
-
If you are using the Standard edition of JIRA you will be brought to the 'Configure Dashboard' page.
If you are using the Professional or the Enterprise edition of JIRA you will be brought to the 'Manage
Dashboards' page, where you can manage your dashboard pages (i.e. multiple dashboards).
You can read more about dashboard pages here, but to
configure your dashboard, locate it on the 'Manage Dashboard' page (under the 'Favourites' or 'My' tab)
and click the 'Full configure' link in the respective 'Operations' column to proceed to the
'Configure Dashboard' page.
-
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 up arrow ( )
closest to select area that contains the portlet. |
| Move a portlet down |
Select the portlet, and click the down arrow ( )
closest to select area that contains the portlet. |
| Move a portlet left |
Select the portlet in the right hand column, and click the left arrow button
( ). |
| Move a portlet right |
Select the portlet in the left hand column, and click the right arrow button
( ). |
| Add a portlet |
Click the button with the plus icon ( ).
Select the desired portlet on the 'Add Portlet' page that displays and click the 'Add' button on that page.
See the Adding a Portlet section below for further details.
|
| Configure a portlet |
Select the portlet, and click the button with the wrench icon
( ). |
| Copy a portlet |
Select the portlet, and click the button with the pages icon
( ). |
| Remove a portlet |
Select the portlet, and click the button with the rubbish bin icon
( ). |
Inline Editing
You can also configure your dashboard 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.
Note, if you are using the default dashboard, a copy will automatically
be made when you click the 'ON' link.
You can configure a portal on the dashboard, in the 'Inline Editing' mode, by using the icons on the portlet's control bar:
| Move a portlet up |
Click the up arrow () in the header of the portlet
that you wish to move. |
| Move a portlet down |
Click the down arrow () in the header of the portlet
that you wish to move. |
| Move a portlet to the top of the column |
Click the curly up arrow ( ) in the header of the portlet
that you wish to move. |
| Move a portlet to the bottom of the column |
Click the curly down arrow () in the header
of the portlet that you wish to move. |
| Move a portlet left |
Click the left arrow button () in the header
of the portlet that you wish to move. |
| Move a portlet right |
Click the right arrow button () in the header
of the portlet that you wish to move. |
| Add a portlet |
Click 'Add new portlet' link with the plus icon () next to it.
Select the desired portlet on the 'Add Portlet' page that displays and click the 'Add' button on that page.
See the Adding a Portlet section below for further details. |
| Configure a portlet |
Click the button with the wrench icon ()
in the header of the portlet that you wish to configure. |
| Copy a portlet |
Click the button with the pages icon ()
in the header of the portlet that you wish to copy. The copied portlet will be placed at
the bottom of the column that the existing portlet is in. This icon will only display for portlets
that have one or more customisable parameters. |
| Remove a portlet |
Click the button with the rubbish bin icon ()
in the header of the portlet that you wish to remove from your dashboard. |
Adding a Portlet
- If you are using the dashboard configuration interface to configure a
dashboard page, click the '+' button
on the 'Configure Dashboard' screen. If you are editing a dashboard page inline,
click the 'Add new portlet' link in the top-right corner of the dashboard.
- The 'Add Portlet' page will display. This page shows you a descriptive list of the available portlets that you
can add to your dashboard.
- Select the radio button for the portlet you want. Some portlets have preview images, which can be
viewed by clicking the thumbnail next to the portlet's description.
- Click the 'Add' button at the bottom of the page.
- If the portlet you have selected requires configuration, you will be presented with the portlet's
configuration page. Configure appropriately and press 'Save'.
- You will be brought back to the page you have started from: either the 'Configure Dashboard' page or the
dashboard itself.
