Documentation for GreenHopper 5.8.x. Documentation for other versions of JIRA Agile is available too.
GreenHopper is now called JIRA Agile. Learn more.

Updated for GreenHopper 5.8 so it is now easier than ever to get up and running with GreenHopper.

Welcome to GreenHopper 101, an introductory guide to the GreenHopper plugin for JIRA and a tour of the most interesting GreenHopper features. Use this page to guide your evaluation process or quickly get up to speed with GreenHopper.

The intended audience for this document is software developers who are familiar with Agile methodologies.

Getting Started

First things first. If you haven't already got the GreenHopper plugin up and running, carry out the following steps.

1. Installing GreenHopper

Before you begin: If you don't already have JIRA 4.4 or later installed, please follow the instructions in the JIRA Installation Guide. If you are new to JIRA, you may find the JIRA 101 guide helpful.

GreenHopper comes pre-installed with JIRA 4.4, so you simply need to activate it.

  1. Log in as a user with the 'JIRA Administrators' global permission.
  2. Click the 'Dashboard' link on the top bar to open your JIRA Dashboard.
  3. In the 'Admin' gadget, click the link 'Start a free trial of GreenHopper'. (If this link doesn't appear, then GreenHopper has already been activated.)
  4. 'Step 1' of the 'GreenHopper setup process' will be displayed.
  5. Go to https://my.atlassian.com and either generate a new Evaluation License Key, or retrieve your old License Key if you already have one.
  6. Paste your License Key into the box on the 'GreenHopper setup process' screen.
  7. Click the 'Finish' button to return to the JIRA Dashboard.
  8. Click the 'Agile' tab to go to GreenHopper.

It should only take you a few minutes to activate the GreenHoppper plugin. If you have any difficulty during the process, please contact our support team for assistance. They're ready to help at any time.

GreenHopper license must match JIRA license

Please note, if you are using a commercial (i.e. not an evaluation) license for GreenHopper, it must match your JIRA license. For example, if you have a JIRA 25 User Commercial license you must have a GreenHopper 25 User Commercial license. GreenHopper evaluation licenses do not need to match JIRA licenses.

2. Setting up a Project

If you don't already have a JIRA project in which to store your Agile tasks, you will need to create one. You can create multiple projects and configure them for Scrum and/or Kanban, depending on your needs.

Before you begin: Note that you will need the 'JIRA Administrators' global permission and the 'Administer Projects' project permission in order to create a JIRA project. If you don't have these permissions, you will need to ask your JIRA administrator to create a project for you.

  1. Click the 'Administration' link at the top of the screen.
  2. Select 'Projects' > 'Projects' then click 'Add Project'.
  3. Type a descriptive Name and unique Key for your project, and select the Project Lead (that is, the person who will manage this project).
  4. After creating your project, exit from JIRA Administration.

For more details, please see the JIRA documentation on Defining a Project.

3. Configuring for Scrum

Scrum is generally used by development teams who are following a roadmap of planned features for upcoming versions of their product.

If you set your GreenHopper project to use the 'Scrum' template, your project will automatically be configured to use Stories, Epics, Story Points, Ranking and Flagging.

(tick)Tip: You have the flexibility to configure the GreenHopper 'Default' template and/or the GreenHopper 'Scrum' template to your organisation's needs — please see the documentation on Specifying your Project Templates. Further, individual projects can override the templates to suit their requirements — please see Configuring your General Project Settings.

To set a project to use the 'Scrum' template:

  1. Ensure that you have been granted the 'Administer Projects' project permission for your project.
  2. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
  3. Click the 'Tools' menu near the top right, then click 'Configuration' from the dropdown menu provided.
  4. Select your project from the project dropdown, if it is not already selected.
  5. In the 'Project Template' dropdown, select 'Scrum'.

You may want to create 'parent-child' relationships between versions, e.g. you could group sprints under a release version ('Sprint 1', 'Sprint 2', etc) under the version for the major release ("Version 1").

  • To set up a version hierarchy, e.g. to break up your major version into sprints:
    1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
    2. From the Project drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
    3. In the column at the right of the screen, click the 'Add' link. The 'Add Version' popup will appear.
    4. In the 'Version Name' field, type the name of your new sprint version (e.g. 'Sprint 1').
    5. In the 'Parent' field, select your major version (e.g. 'Version 1').
    6. Optionally, enter the 'Start Date', 'End Date', 'Release Date' and 'Decription' for your new sprint version.
    7. Click the 'Create' button to create the verion and keep the 'Add Version' popup open (so you can create another version, e.g. 'Sprint 2'), or click the 'Create and Close' button to create the version and return to the Planning Board.

For more information, please see the GreenHopper documentation on Setting Up a Version Hierarchy and the JIRA documentation on Managing Versions.

To force all issues to respect the hierarchy you have set up, you can 'synchronise' versions and components. You can do this either manually or automatically; for more information, please see the documentation.

  • To synchronise your versions automatically:
    1. Click the 'Administration' menu in the top navigation bar.
    2. Select 'Plugins' > 'GreenHopper' > 'General Configuration''.
    3. In the 'GreenHopper Listeners and Services' section, click the 'Versions Synchronizer' check-box.

4.  Configuring for Kanban

  1. Click the 'Agile' menu in the top navigation bar and select 'Rapid Board' from the drop-down menu.
  2. Select 'Create' from the 'cog' menu at the top-right of the page.
    (info) Alternatively, if you are on the 'Getting Started' page, simply click 'Create a New Rapid View'.
  3. Click 'Select Kanban' on the 'Presets' tab.
  4. Enter the name of your new Rapid View, and select the project(s) you wish to work on.

For more information, please see Creating a Rapid View.

Constraints specify how many issues a column can contain. If the constraint for a column is exceeded, the constraint will be highlighted in red.

To set constraints based on the number of issues in a given column:

  1. Click the 'Agile' menu in the top navigation bar and select 'Rapid Board' from the drop-down menu.
  2. On the 'Manage Rapid Views' screen, click the 'Configure' link corresponding to the Rapid View of interest.
  3. On the 'Rapid View Configuration' screen, click the 'Columns' tab.
  4. In the 'Column Constraint' drop-down, select 'Issue Count'.
  5. To set the columns 'Max' constraint, click the red box at the top of the column, type the new value and press the 'Enter' key. E.g. if your business practice is to have no more than 5 issues 'In Progress' at any one time, you would specify 5.
  6. Close the 'Use Rapid View' button (at the top of the page). Your Rapid Board will refresh with the column constraint applied. If the total number of issues in that column of your Rapid View exceeds the maximum capacity, the column will be highlighted in red.

For more information, please see Setting Column Constraints.

Working with Issues

In GreenHopper 5.8 we recommend that Scrum teams use the Planning Board and the Task Board, and that Kanban teams use the Rapid Board.

5. Viewing the "To Do" List

On the Task Board (if you are using Scrum):

  1. Click the 'Agile' menu in the top navigation bar and select 'Task Board'.
  2. From the Project drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
    (tick)Tip: the Task Board will not be displayed if you have not yet configured a version for your project.
  3. From the Versions drop-down at the top left of the screen, select the version in which you are interested.
  4. If you wish to see only the issues that are assigned to you, click the 'filters' icon at the left of the screen and select the 'Only My Issues' check-box.

(info) For more information, please see Using Task Board Modes.

On the Rapid Board (if you are using Kanban):

  1. Click the 'Agile' menu in the top navigation bar and select 'Rapid Board'.
  2. Select your preferred Rapid View, then click the 'Work' tab.
  3. If you wish to see only the issues that are assigned to you, click the 'Only My Issues' button.

(info) For more information, please see Using the Rapid Board.

6. Creating an Issue

  1. Click the 'Create Issue' link at the top of the screen.

  2. Enter your issue details into the 'Create Issue' dialog box, as shown below.
    (tick) If you select the 'Create another' check box, JIRA will create your issue and automatically pre-populate a new 'Create Issue' dialog box with your previous issue details, while leaving the 'Summary' field blank. This allows you to rapidly create a series of issues with similar details.

    (tick) If you wish to choose which fields will appear when you create (or edit) an issue, click the 'Configure Fields' button.

For more information, please see Creating an Issue.

7. Ranking Issues

Ranking your issues/cards helps you organise and prioritise tasks in your product/sprint backlog more effectively.

On the Planning Board (if you are using Scrum):

  1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
  2. In the Projects drop-down top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Modes drop-down (to the right of the words 'Planning Board'), select 'Project Overview'.
  4. In the Context drop-down (which will display 'Default' is this is a new installation and your first visit), select 'On the fly'.
  5. In the Context drop-down, select 'Manage Context'.
  6. Click the 'Sort' tab. In the 'Sort by' field, select 'Rank'.
  7. You can now rank your issues by dragging and dropping the cards on your Planning Board as desired.

(info) For more information, please see Ranking Issues in GreenHopper.

On the Rapid Board (if you are using Kanban):

  1. Click the 'Agile' menu in the top navigation bar and select 'Rapid Board' from the drop-down menu.
  2. Select your preferred Rapid View, then click the 'Work' tab.
  3. Rank an issue by dragging and dropping it to a higher or lower position within its current column.

(info) For more information, please see Ranking an Issue.

8. Scheduling and Assigning Issues

This applies to Scrum projects.

  1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
  2. In the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Modes drop-down (to the right of the words 'Planning Board'), select 'Version' (or 'Component' or 'Assignee' or 'Project Overview' — whichever is most relevant to the issues you need to schedule/assign).
  4. If you have selected 'Version', 'Component' or 'Assignee', a second dropdown will display that you can select the desired version, component or assignee from.
  5. Drag and drop the desired card(s) to the version (or component or assignee) to which you want to assign the issue(s).
    (info) You can select multiple cards by using the <Control> (or <Command>) key, or by <Shift> selecting cards.

For more information, please see Scheduling and Assigning Issues in GreenHopper.

9. Transitioning Issues through Statuses

On the Task Board (if you are using Scrum):

  1. Click the 'Agile' menu in the top navigation bar and select 'Task Board' from the drop-down menu.
  2. In the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Versions drop-down, select the version in which you are interested. Please note, you will not be able to select 'Unscheduled' or any released versions in this dropdown.
  4. Drag and drop the desired card(s) to the column that matches the status to which you want to assign the issue(s).
    (info) For more information, please see Transitioning Issues in GreenHopper.

On the Rapid Board (if you are using Kanban):

  1. Click the 'Agile' menu in the top navigation bar and select 'Rapid Board'.
  2. Select your preferred Rapid View, then click the 'Work' tab.
  3. Drag and drop the desired card(s) to the column that matches the status to which you want to assign the issue(s).
    (warning) If moving an issue causes a constraint to be exceeded, the affected constraint will be displayed in red (maximum) or yellow (minimum).
    (info) For more information, please see Transitioning an Issue.

10. Using Keyboard Shortcuts

  • click 'a' to assign an issue.
  • click 'l' to label an issue.
  • click 'm' is comment on an issue.
  • click 'z' to display the Planning Board, Task Board or Rapid Board in 'Projector' mode (i.e. full-screen).
  • click '.' for the JIRA Operations dialog.
  • click 'j' to go to the next issue (down) in a column on the Rapid Board.

  • click 'k' to go to the previous issue (up) in a column on the Rapid Board.
  • click 'n' to go to the next (right) column on the Rapid Board.
  • click 'p' to go to the previous (left) column on the Rapid Board.
  • click 't' to toggle between hiding or showing the detailed view of the currently selected issue on the Rapid Board.
  • click 'o' to open the issue which is currently showing in the detailed view on the Rapid Board.
  • click 'Enter' to submit the content of a field being edited in the detailed view on the Rapid Board.
  • click 'Shift' + 'Enter' to add a new line to a field being edited in the detailed view on the Rapid Board.
  • click 's' + 't' to move an issue to the top of the current column on the Rapid Board. (Only applicable if Ranking has been enabled.)

  • click 's' + 'b' to move an issue to the bottom of the current column on the Rapid Board. (Only applicable if Ranking has been enabled.)

(info) For more information, please see Using Keyboard Shortcuts.

Searching and Reporting

11. Viewing a Project's Backlog

This applies to Scrum projects.

  1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
  2. In the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Modes drop-down, select either:
    • 'Project Overview' to view issues assigned to all unreleased versions of a project.
    • 'Component' to view issues assigned to a particular component of all unreleased versions of a project.
    • 'Version' to view issues assigned to a particular unreleased versions of a project.
    • 'Assignee' to view issues assigned to a particular person for all unreleased versions of a project.

For more information, please see Using Planning Board Modes.

12. Viewing a Burndown Chart

This applies to Scrum projects.

  1. Click the 'Agile' menu in the top navigation bar and select 'Chart Board' from the drop-down menu.
  2. In the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Versions drop-down, select the version in which you are interested.
  4. In the Charts drop-down, select "Hour Burndown Chart".

For more information, please see Using the Chart Board.

  1. Click the 'Agile' menu in the top navigation bar and select 'Chart Board' from the drop-down menu.
  2. In the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Versions drop-down, select the version in which you are interested.
  4. In the Charts drop-down, select "Issue Burndown Chart".

For more information, please see Using the Chart Board.

  1. Click the 'Agile' menu in the top navigation bar and select 'Released Board' from the drop-down menu.
  2. In the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you are interested.
  3. In the Versions drop-down, select the version in which you are interested.
  4. In the Charts drop-down, select "Burndown Chart"

For more information, please see Using the Released Board.

13. Filtering Issues

You can filter issues on-the-fly, enabling you for example to only see issues of a particular type (such as 'Bug'). You do this by creating a 'Context' for the Planning Board or Task Board, or a 'Quick Filter' for the Rapid Board.

  1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' (or 'Task Board' or 'Chart Board') from the drop-down menu.
  2. Select the project in which you are interested.
  3. Select 'New' from the Context drop-down (which will display 'Default' if this is a new installation and your first visit).
  4. On the General tab, in the 'Context name' field, type 'Bugs only' (or whatever is appropriate for your needs).
  5. On the Filter tab, in the 'Issue Type' field, select 'Bugs' (or whatever is appropriate for your needs).
  6. Click the 'Save and Apply' button.
  7. The Planning Board (or 'Task Board' or 'Chart Board') will now only display Bugs.

You can create Contexts that use many different fields, or a JIRA issue filter. For details, see Creating a New Context.

  1. Click the 'Agile' menu in the top navigation bar and select 'Manage Rapid Views' from the drop-down menu.
  2. On the 'Manage Rapid Views' screen, click the 'Configure' link corresponding to the Rapid View of interest.
  3. On the 'Rapid View Configuration' screen, click the 'Quick Filters' tab.
  4. In the 'Name' field, type 'Bugs only' (or whatever is appropriate for your needs).
  5. In the 'JQL' field, type 'Bugs' (or whatever is appropriate for your needs).
  6. Click the 'Add' button.
  7. Your Rapid Board will now have a new button (e.g. called 'Bugs') for your new Quick Filter.
    (info) For more details, please see Configuring a Rapid View

14. Using the GreenHopper Gadgets

The Agile Gadget is particularly useful for Scrum teams.

  1. Click the 'Dashboards' link in the top navigation bar.
  2. Click the 'Add Gadget' link at the top right of your dashboard. The 'Gadget Directory' screen will display.
  3. Find the 'GreenHopper Agile Gadget' in the list of gadgets and click the 'Add it now' button.
  4. Click the 'Finished' button at the bottom right of the Gadget Directory.
  5. The 'GreenHopper Agile Gadget' gadget will display on your dashboard. Enter the following setup details for your gadget:
    • 'Project or Saved Filter' — the JIRA project or saved filter for which you want to display GreenHopper data.
    • 'Display chart values' — whether or not you want to display the plot values on the chart.
    • 'Display chart legend' — whether or not you want to display the legend at the bottom of the chart.
    • 'Refresh Interval' — how often the data in the gadget will refresh.
  6. Click the 'Save' button.

For more information, please see the documentation on the GreenHopper Agile Gadget and the JIRA Dashboard.

14. Creating a Wallboard

A Wallboard displays vital data about project progress to anyone walking by.

There are two ways to create a wallboard: via the GreenHopper Planning Board or via the JIRA dashboard.

(info) This will create a project-specific wallboard. To use this procedure, you must be logged in to JIRA as a project lead.

  1. Ensure that the JIRA Wallboards Plugin has been installed. (This is similar to installing the GreenHopper plugin as described above.)
  2. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
  3. Select your project from the project dropdown, if it is not already selected.
  4. Select the 'Project Overview' viewing mode from the drop-down menu under the Project name.
  5. Click the 'cog' icon (which will appear when you hover over the Project Overview column on the right) to display a drop-down menu.
  6. Select 'Create Wallboard'.
    1. A wallboard will be created with the name '<Project name> (autogenerated)' and displayed. Your wallboard is a new page on your JIRA dashboard, and will contain:
    2. Select 'View as Wallboard' from the 'Tools' drop-down on your JIRA dashboard, and stare in awe at your fresh new wallboard. For optimal use of screen real-estate, enter full-screen mode on your browser (F11 in Firefox 3.6 and Chrome 5; Safari requires a plugin to enable full-screen mode) and refresh. Wallboards are optimised for 1920x1080 and 1920x1200 screens, but should work in some other resolution modes.
    (info) If you have already created a wallboard for your project, the 'View Wallboard' menu option will be displayed instead of 'Create Wallboard'.

For more information, please see the documentation on the Wallboards Plugin and the JIRA Dashboard.

  1. Ensure that the JIRA Wallboards Plugin has been installed. (This is similar to installing the GreenHopper plugin as described above.)
  2. Click the 'Dashboard' menu in the top navigation bar and create a new JIRA dashboard for your new wallboard.
    (info) Since existing dashboards may contain gadgets which are not wallboard-compatible, avoid copying an existing dashboard.
  3. Add one or more wallboard-compatible gadgets to your new dashboard. (See the Adding a Gadget instructions for details.)
    Any wallboard-compatible gadgets added to this dashboard will be shown on the wallboard.
    (tick)Tip: By default, all available gadgets are listed. However, many of these gadgets are not wallboard-compatible. To restrict the list of gadgets to wallboard-compatible ones only, select the 'Wallboard' category on the left of the 'Gadgets Directory' dialog box.
  4. Select 'View as Wallboard' from the 'Tools' drop-down on your dashboard and stare in awe at your fresh new wallboard. For optimal use of screen real-estate, enter full-screen mode on your browser (F11 in Firefox 3.6 and Chrome 5; Safari requires a plugin to enable full-screen mode) and refresh the page. Wallboards are optimised for 1920x1080 and 1920x1200 pixel resolution screens, but should also work in some other resolution modes.

For more information, please see the documentation on the Wallboards Plugin and the JIRA Dashboard.

 

 

Thank you for reading this guide.

Thanks for taking the time to try GreenHopper using this guide. To help continue your journey, our support staff are always ready to answer your questions in Atlassian Answers for GreenHopper, or solve specific problems at our support portal http://support.atlassian.com.

  • No labels