Documentation for GreenHopper 4.3.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

Updated for GreenHopper 4.3 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

1. Installing GreenHopper

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

  Installing the GreenHopper plugin: (click to expand)

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

  1. Download GreenHopper. If you have a .zip simply rename your file as a .jar — Internet Explorer is playing tricks on you.
  2. Shut down JIRA.
  3. Replace or copy the jar into the {JIRA_HOME}/plugins/installed-plugins directory.
    (info) The default {JIRA_HOME} location is C:\Program Files\Atlassian\Application Data\JIRA, if you are using Windows. Read more about the JIRA Home directory.
  4. Remove any jira-greenhopper-plugin-*.jar from your {JIRA_INSTALL}/atlassian-jira/WEB-INF/lib directory.
    (info) The {JIRA_INSTALL} location will be something like C:\Program Files\Atlassian\JIRA 4.0.0, if you are using Windows. Read more about the JIRA Installation directory.
  5. Restart JIRA.

For more help on the technical procedures in this section, see the GreenHopper Installation Guide.

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

  Entering your GreenHopper License: (click to expand)

You can obtain your GreenHopper license, or generate an evaluation license, via your Atlassian account.

  1. Log in as a user with the 'JIRA Administrators' global permission.
  2. Click the 'Administration' menu in the top navigation bar and select 'JIRA Administration'.
  3. Click the 'Licence Details' link under the 'GreenHopper' section of the administration menu. This will display the 'GreenHopper License' screen.
  4. Enter your license details and click 'Add'.

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.
  Installing the Labels Plugin: (click to expand)

It is recommended that you install the Labels Plugin so that you can utilise Epics in your GreenHopper projects.

  1. Download the Labels plugin. If you have a .zip simply rename your file as a .jar — Internet Explorer is playing tricks on you.
  2. Shut down JIRA.
  3. Replace or copy the jar into the {JIRA_HOME}/plugins/installed-plugins directory.
    (info) The default {JIRA_HOME} location is C:\Program Files\Atlassian\Application Data\JIRA, if you are using Windows. Read more about the JIRA Home directory.
  4. Remove any jira-greenhopper-plugin-*.jar from your {JIRA_INSTALL}/atlassian-jira/WEB-INF/lib directory.
    (info) The {JIRA_INSTALL} location will be something like C:\Program Files\Atlassian\JIRA 4.0.0, if you are using Windows. Read more about the JIRA Installation directory.
  5. Restart JIRA.

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 (next to 'PROJECT CONFIGURATION'), 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 black arrow in the top right of the column.
    5. Click 'Column Constraints'.
    6. Click the 'Edit' link for the 'Standard Issue Count' field, and enter the maximum 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).

3. Configuring JIRA

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.

  Setting up a Version Hierarchy: (click to expand)

You may want to create 'master-slave' 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. In the 'PLANNING BOARD' field, 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 'Master' field, select your major version (e.g. 'Version 1').
    6. Enter the 'Start 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 and select 'JIRA Administration'.
    2. Click the 'General Configuration' link under the 'GreenHopper' section of the administration menu.
    3. In the 'GreenHopper Listeners and Services' section, click the 'Versions Synchronizer' check-box.
  Enabling Time-Tracking: (click to expand)

If you want to be able to log the amount of time you spend working on issues, you need to first enable time-tracking in JIRA.

  • To enable time-tracking::
    1. Click the 'Administration' menu in the top navigation bar and select 'JIRA Administration'.
    2. Click 'Time Tracking' (under 'Global Settings') in the left navigation column.
    3. In the 'Hours Per Day' field, enter the number of hours in your organisation's working day (e.g. 8).
    4. In the 'Days Per Week' field, enter the number of days in your organisation's working week (e.g. 5).
    5. Leave the 'Time Format' as 'pretty'.
    6. Change the 'Default Unit' to 'hour'.
    7. Click the 'Activate' button.
      For more about configuring time-tracking, please see the JIRA documentation.
  Enabling Sub-tasks: (click to expand)

If you want to be able to split up a 'parent' issue (e.g. a 'Story') into a number of sub-tasks which can be assigned and tracked separately, you need to first enable sub-tasks in JIRA.

  • To enable sub-tasks:
    1. Click the 'Administration' menu in the top navigation bar and select 'JIRA Administration'.
    2. Click 'Sub-Tasks' (under 'Global Settings') in the left navigation column.
    3. Click the 'Enable' link.
      For more about configuring sub-tasks, please see the JIRA documentation.

Working with Issues

4. 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. In the 'TASK BOARD' field, 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. In the 'View Version' field, select the version in which you are interested.
  4. If you wish to see only the issues that are assigned to you, click the 'My Issues' check-box.

For more information, please see the documentation on Using Task Board Modes to View Issues.

5. 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. In the 'PLANNING BOARD' (or 'TASK BOARD' or 'CHART BOARD') field, select the project in which you wish to create an issue.
  3. Click the 'New card' button (next to the project dropdown).
  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.

6. 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. In the 'PLANNING BOARD' (or 'TASK BOARD' or 'CHART BOARD') field, select the project containing the issue you wish to flag.
  3. Find the issue and double-click it to display it as a 'Detailed Card'.
  4. Click the black triangle in the top right corner of the card and select 'Flag' from the drop-down menu.

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

7. 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 'PLANNING BOARD -' field, select the project in which you are interested.
  3. In the 'View' field, select 'Project Overview'.
  4. In the 'Context' field, select 'On the fly'.
  5. Click the 'Tools' menu at the right of the screen and select 'Context' from the drop-down menu.
  6. In the 'Sort by' field, select 'Rank' (i.e. the Ranking field that you set up in 'Configuring JIRA and GreenHopper' above).
  7. You can now rank your issues by dragging and dropping the cards/rows on your Planning Board as desired.

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

8. 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 'PLANNING BOARD' field, select the project in which you are interested.
  3. In the 'View' field, 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)/row(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.

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

9. 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 'TASK BOARD' field, select the project in which you are interested.
  3. In the 'View Version' field, 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)/row(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.

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 'PLANNING BOARD' field, select the project in which you are interested.
  3. In the 'View' field, 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 Planning Board Modes to View Issues.

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 'CHART BOARD' field, select the project in which you are interested.
  3. In the 'View Version' field, select the version in which you are interested.
  4. In the 'BURNDOWN CHART' field, select "HOUR BURNDOWN CHART".

For more information, please see the documentation on Using the 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 'CHART BOARD' field, select the project in which you are interested.
  3. In the 'View Version' field, select the version in which you are interested.
  4. In the 'BURNDOWN CHART' field, select "ISSUE BURNDOWN CHART".

For more information, please see the documentation on Using the Chart Board.

  To view the hour 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 'RELEASED BOARD' field, select the project in which you are interested.
  3. In the 'RELEASE' field, select "RELEASE CHARTS".
  4. In the 'View' field, select the version in which you are interested.

For more information, please see the documentation on Using the 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. In the 'PLANNING BOARD' (or 'TASK BOARD' or 'CHART BOARD' or 'RELEASED BOARD') field, select the project in which you wish to search.
  3. 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. Click the 'New' link next to the 'Context' field.
  4. In the 'Context name' field, type 'Bugs'.
  5. 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.

14. Using the "Agile" Gadget

This is particularly useful for Scrum users.

  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 '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 '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 Agile Gadget 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