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

Skip to end of metadata
Go to start of metadata
Icon

Updated for GreenHopper 5.7 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.

 Activating the GreenHopper Plugin: (click to expand)

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

Icon
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. Configuring GreenHopper

Before you begin: Note that you will need the 'JIRA Administrators' global permission and the 'Administer Projects' project permission to perform the tasks in this section. You will also need to have created at least one JIRA project.

  Configuring GreenHopper for Scrum: (click to expand)

If you set your GreenHopper projects to use the 'Scrum' template, your projects 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. Click the 'Agile' menu in the top navigation bar. The 'Planning Board' (or 'Task Board' or 'Chart Board', depending on the last board you visited) will be displayed.
    2. Click the 'Tools' menu near the top right, then click 'Configuration' from the dropdown menu provided.
    3. Select your project from the project dropdown, if it is not already selected.
    4. In the 'Project Template' dropdown, select 'Scrum'.
  Configuring Constraints: (click to expand)

You can implement one of the most useful Kanban concepts by simply adding Column Constraints to your Task Board. If the constraints for a column are exceeded, the column 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 'Task Board'.
    2. Click the 'Views' menu at the right of the screen and select 'Compact (Kanban)' from the drop-down menu.
    3. Select the project for which you wish to set a constraint.
    4. In the appropriate column (e.g. the 'In Progress' column), click the 'cog' icon (which will appear at the top right of the column when you hover over the column name).
    5. Click 'Column Constraints'.
    6. Click the 'Edit' link for the 'Standard Issue Count' field, and enter the maximum and/or minimum in the 'Capacity' field. E.g. if your business practice is to have no more than 5 issues 'In Progress' at any one time, you would specify 'Max'=5.
      (info) 'Standard' issues exclude sub-tasks.
    7. Click 'Update'. Your changes will be saved.
    8. Close the 'Column Constraints' window. Your Task Board will refresh with the column constraint applied. If the total number of issues in that column of your Task Board exceeds the maximum capacity, the column will be highlighted in red.

For more information, please see the documentation on Adding Constraints to your Task Board Columns (Kanban).

  Setting up a Version Hierarchy: (click to expand)

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.

Working with Issues

3. Viewing the "To Do" List

  To view the "To Do" list for your project or yourself: (click to expand)
  1. Click the 'Agile' menu in the top navigation bar and select 'Task 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.
    (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.

For more information, please see the documentation on Using Classic Task Board Modes.

4. Creating an Issue

  To log one or more new issues/cards: (click to expand)
  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. From the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project in which you wish to create an issue.
  3. Click the 'New card' button at the right of the screen.
  4. Fill out the 'New issue' form (this is similar to creating a new issue directly in JIRA).
  5. Click the 'Create' button to create the issue and keep the 'New issue' window open (so you can create another issue), or click the 'Create and close' button to create the issue and return to your board.

For more information, please see the documentation on Creating an Issue in GreenHopper and Creating an Issue in JIRA.

5. Flagging an Issue

Flagging a card/issue indicates that it requires special attention.

  To flag an issue: (click to expand)
  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. From the Projects drop-down at the top left of the GreenHopper screen (not in the JIRA header), select the project containing the issue you wish to flag.
  3. Find the issue, click the 'cog' icon (which will appear when you hover over the Issue Type or Priority icons), and select 'Flag' from the drop-down menu that appears.

For more information, please see the documentation on Flagging an Issue in GreenHopper Classic

6. Ranking Issues

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

  To rank issues in your project: (click to expand)

(tick) Tip: If the currently selected project is using the 'Scrum' Project Template you may skip the steps below as it sets the 'Sort by' field of the Default context to 'Rank' automatically.

  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.

For more information, please see the documentation on Ranking Issues in GreenHopper Classic.

7. Scheduling and Assigning Issues

  To schedule and assign issues/cards: (click to expand)
  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 the documentation on Scheduling and Assigning Issues in GreenHopper Classic.

8. Transitioning Issues through Statuses

  To move an issue from one JIRA status to another: (click to expand)
  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).

For more information, please see the documentation on Transitioning Issues in GreenHopper Classic.

(warning) Note for Kanban users: if moving an issue causes a constraint to be exceeded, the affected column will be displayed in red (maximum) or yellow (minimum).

8. Transitioning Issues through Statuses

  To move an issue from one JIRA status to another: (click to expand)
  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).

For more information, please see the documentation on Transitioning Issues in GreenHopper.

(warning) Note for Kanban users: if moving an issue causes a constraint to be exceeded, the affected column will be displayed in red (maximum) or yellow (minimum).

9. Using Keyboard Shortcuts

  To work with issues without touching the mouse: (click to expand)
  • 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 or Task Board in 'Projector' mode.
  • click '.' for the Operations dialog.

For more information, please see Using Keyboard Shortcuts.

Searching and Reporting

10. Viewing a Project's Backlog

  To view the issues assigned to unreleased versions of a project: (click to expand)
  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 the documentation on Using Classic Planning Board Modes.

11. Viewing a Burndown Chart

  To view the hour burndown chart for an unreleased version: (click to expand)
  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 the documentation on Using the Classic Chart Board.

  To view the issue burndown chart for an unreleased version: (click to expand)
  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 the documentation on Using the Classic Chart Board.

  To view the burndown chart for a released version: (click to expand)
  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 the documentation on Using the Classic Released Board.

12. Searching for Issues

  To search for issues/cards in a particular project: (click to expand)
  1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' (or 'Task Board' or 'Chart Board' or 'Released Board') from the drop-down menu.
  2. Type your search criteria in the 'Board Search' box and press the <Enter> key. Your search criteria can be any of the following:
    • The complete issue key.
    • The numeric part of the issue key.
    • Plain text contained in the comments, description or summary field of the issue.

For more information, please see the documentation on Searching for Issues in GreenHopper and Searching for Issues in JIRA.

13. Filtering Issues

A 'Context' is a filter that you apply to a board, e.g. enabling you to only see issues of a particular type.

  To create a new Context showing Bugs only: (click to expand)
  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'.
  5. On the Filter tab, in the 'Issue Type' field, select 'Bugs'.
  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 the documentation on Creating a New Context.

GreenHopper also provides built-in Quick Filters, which enable you to refine the collection of displayed cards.

  To hide Sub-Tasks: (click to expand)
  1. Click the 'Hide Sub-Tasks' button on the top left of the board.
  2. The Planning Board (or Task Board) will now only display issues (no Sub-Tasks).

For more information about the filters available on each board, please see the documentation on Using the Classic Planning Board and Using the Classic Task Board.

14. Using the "Agile" Gadget

This is particularly useful for Scrum teams.

  To display GreenHopper data on your JIRA dashboard: (click to expand)
  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.

15. 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.

 To create a GreenHopper wallboard for your project from the GreenHopper Planning Board: (click to expand)

(info) 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.

 To create a GreenHopper wallboard from the JIRA dashboard: (click to expand)
  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