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

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)
  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 'GreenHopper Licence' link under the 'System' 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

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 JIRA and GreenHopper

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

  Setting up Story Points: (click to expand)
  • Adding the 'Story' issue type:
    1. Click the 'Administration' menu in the top navigation bar and select 'JIRA Administration'.
    2. Click the 'Issue Types' link from the menu at the left of the screen.
    3. In the 'Add New Issue Type' form, in the 'Name' field, type 'Story. In the 'Description' field, type 'Used by GreenHopper'. Then click the 'Add' button'. (For more about adding Issue Types, and icons, please see the JIRA documentation.)
      (info) By default, your new 'Story' issue type has been added to the JIRA 'Default Issue Type Scheme'. If other departments in your organisation use JIRA, you may need to create a new scheme (e.g. 'Agile Issue Type Scheme'), add your 'Story' type to it, and associate the new scheme with each of your Agile projects. For more about Issue Type Schemes, please see the JIRA documentation.
  • Adding the 'Story Points' custom field:
    1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
    2. Click the 'Stats' link at the right of the screen.
    3. In the 'Statistics' popup, click the 'Add a Number Field to your Project' link.
    4. In the 'Field Name' field, type 'Story Points'.
    5. In the 'Description' field, type 'Used by GreenHopper Scrum projects'.
    6. In the 'Choose Search Template' field, select 'Number Searcher'.
    7. In the 'Choose Applicable Issue Types' field, select 'Story'.
    8. In the 'Choose Applicable Context' field, select either:
      • 'Global' — your 'Story Points' field will be visible on all issues in JIRA. (Not recommended if other departments in your organisation use JIRA.)
      • 'Projects' (select the relevant projects) — your 'Story Points' field will only be visible on issues in the specified projects.
    9. Click the 'Finish' button.
    10. In the 'Associate field Story Points to screens' list, select the 'Default Screen'.
    11. Click the 'Update' button.
    12. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' from the drop-down menu.
    13. Click the 'Stats' link at the right of the screen.
    14. In the 'Statistics' popup, verify that 'Story Points' appears in the 'Field Name' drop-down, and click the 'Add' button.
      For more information, please see the GreenHopper documentation on Configuring a Custom Statistic and the JIRA documentation on Adding a Custom Field.
  • Configuring a card template for the 'Story' issue type:
    (Note that you will need to do the following for each project that uses the 'Story' issue type.)
    1. Click the 'Agile' menu in the top navigation bar and select 'Planning Board' (or 'Task Board' or 'Chart Board' or 'Released Board').
    2. Select a project which uses the 'Story' issue type.
    3. Click the 'Tools' menu at the right of the screen and select 'Configuration'.
    4. Click the 'CARD TEMPLATES' tab.
    5. In the 'ISSUE TYPE' drop-down, select 'Story'.
    6. In the 'List view' section, select 'Story Points' and click the 'Add field' button.
    7. In the 'Card view' section, select 'Story Points' and click the 'Add field' button.
      (tick) Tip: If you wish to change the card colour, click the 'Card colour' link at the top right of the page. For more information, please see the documentation on Configuring your Card Templates.
  Setting up Ranking: (click to expand)
  • Adding the 'Rank' custom field:
    If you configure a 'Rank' field, users will be able to rank cards/issues as described below in 'Working with issues'.
    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. Click the 'Tools' menu at the right of the screen and select 'Configuration' from the drop-down menu.
    3. Select a project which will use the 'Rank' custom field.
    4. Click the 'Add a Ranking Field to your Project' link.
    5. In the 'Field Name' field, type 'Rank'.
    6. In the 'Choose Applicable Context' field, select either:
      • 'Global' — your 'Rank' field will be visible on all issues in JIRA. (Not recommended if other departments in your organisation use JIRA.)
      • 'Projects' (select the relevant projects) — your 'Rank' field will only be visible on issues in the specified projects.
    7. Accept all the other field defaults on the 'Add Field' page. Click the 'Finish' button.
    8. On the 'Associate field Rank to screens' page, click the 'Cancel' button.
    9. 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.
    10. Click the 'Tools' menu at the right of the screen and select 'Configuration' from the drop-down menu.
    11. Select a project which will use the 'Rank' custom field.
    12. In the 'Ranking field' section, in the 'Field name' field, select 'Rank' and click the 'Add field' link.
      For more information, please see the GreenHopper documentation on Configuring your General Project Settings and the JIRA documentation on Adding a Custom Field.
  Setting up a Version Hierarchy: (click to expand)

You may want to create 'master-slave' relationships between versions, e.g. you could group your sprints as milestone versions ('Version 1 m1', 'Version 1 m2', etc) under the version for the major release ("Version 1").

  • To set up a version hierarchy, i.e. to make a version the 'slave' of another version:
    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' drop-down field (below the project selection field), select 'Versions'. in which you are interested.
    4. In the column at the right of the screen, locate the version which will become a 'slave'.
    5. Click the 'Edit' icon next to the 'Master' field and select the version which will become the 'master'.
      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 'GreenHopper' link from the menu at the left of the screen.
    3. In the 'GreenHopper Listeners and Services' section, click the 'Versions Synchronizer' check-box.

3. Optional Extra Configuration

  Setting up Flagging: (click to expand)

If you configure a 'Flag' field, users will be able to flag cards/issues as described below in 'Working with issues'.

  • To create a custom field called 'Flag' with the value 'Warning':
    1. Click the 'Administration' menu in the top navigation bar and select 'JIRA Administration'.
    2. Click the 'Custom Fields' link from the menu at the left of the screen, then click the 'Add Custom Field' link.
    3. Select "Multi Select, then click the 'Next' button.
    4. In the 'Field Name' field, type 'Flag'.
    5. In the 'Description' field, type 'Used by GreenHopper projects'.
    6. In the 'Choose Search Template' field, select 'Multi Select Searcher'.
    7. In the 'Choose Applicable Issue Types' field, select 'Any issue type'.
    8. In the 'Choose Applicable Context' field, select either:
      • 'Global' — your 'Flag' field will be visible on all issues in JIRA. (Not recommended if other departments in your organisation use JIRA.)
      • 'Projects' (select the relevant projects) — your 'Flag' field will only be visible on issues in the specified projects.
    9. Click the 'Finish' button.
    10. On the 'Associate field Flag to screens' page, click the 'Cancel' button.
    11. Click the 'Configure' link next to your 'Flag' field.
    12. Click the 'Edit Options' link.
    13. In the 'Add New Custom Field Option' field, type 'Warning'.
    14. Click the 'Add' button, then the 'Done' button.
    15. 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.
    16. Click the 'Tools' menu at the right of the screen and select 'Configuration' from the drop-down menu.
    17. Select a project which will use the 'Flag' custom field.
    18. In the 'Flagging field' section, in the 'Field name' field, select 'Flag'. 'Warning' will be automatically selected in the 'Field Value' field.
      For more information, please see the GreenHopper documentation on Configuring your General Project Settings and the JIRA documentation on Adding a Custom Field.
  Setting Constraints: (click to expand)

You can implement one of the most useful Kanban concepts by simply adding Column Constraints to your Task Board for the 'Story Points' custom field created above.

  • To set constraints based on the 'Story Points' field:
    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 '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 'Story Points' field, enter the constraints* and click 'Update'. Your changes will be saved.
      (info) *e.g. if your business practice is to have no more than 15 Story Points 'In Progress' at any one time, you would specify 'Max'=15.
    7. Close the 'Column Constraints' window. Your Task Board will refresh with the column constraints applied. If the constraints for the column are exceeded, the column will be highlighted in red.
      For more information, please see the documentation on Adding Constraints to your Task Board Columns (Kanban).
  Changing the card colours: (click to expand)

Each GreenHopper card displays a particular colour depending on its issue type.

  • To change the default card colours, or to select colours for your custom issue type(s):
    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. Click the 'Tools' menu at the right of the screen and select 'Configuration' from the drop-down menu.
    3. Select the project for which you wish to change the card colours.
    4. Click the 'CARD TEMPLATES' tab.
    5. In the 'ISSUE TYPE' field, select the relevant issue type, then click the 'Card colour' link at the right of the field and choose the appropriate colour.
      For more information, please see the documentation on Configuring your Card Templates.
  Enabling Sub-tasks and Time-Tracking: (click to expand)
  • Enabling time-tracking:
    If you want to be able to log the amount of time you spend working on issues, you need to first do the following:
    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:
    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 do the following:
    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.
  Assigning Issues to a single Version and Component: (click to expand)
  • Assigning issues to a single version:
    Note that GreenHopper supports only one Fix Version per issue. If an issue is assigned to multiple versions, GreenHopper will only use the first one in the list. It is recommended that you edit each issue and assign it to only one version. Depending on how many issues you have, it may be quickest to use the JIRA 'Bulk Edit' feature as follows:
    1. Display the relevant issues in the JIRA Issue Navigator
      (tick) Tip: to display a GreenHopper collection of issues in the JIRA Issue Navigator, click the 'Issue Navigator' icon on the GreenHopper Planning Board.
    2. From the 'Tools' menu at the top right of the Issue Navigator, select 'Bulk Change'.
    3. Select the relevant issues and click the 'Next' button.
    4. Select 'Edit Issues' and click the 'Next' button.
    5. Select the 'Change Fix Version/s' check-box, select just one Fix Version, and click the 'Next' button.
    6. If the 'Confirmation' screen looks as you expect, click the 'Confirm' button.
  • Assigning issues to a single component:
    Note that GreenHopper supports only one component per issue, so if an issue belongs to multiple components, GreenHopper will only use the first one in the list. (Note: components are listed alphabetically, so if there are three components selected — 'cats', 'dogs', 'planes' — it will only use 'cats'.) In agile programming, if a task/issue is so broad that it covers many components, it should be broken down into smaller tasks. It is recommended that you edit each issue and assign it to only one component. Depending on how many issues you have, it may be quickest to use the JIRA 'Bulk Edit' feature as follows:
    1. Display the relevant issues in the JIRA Issue Navigator
      (tick) Tip: to display a GreenHopper collection of issues in the JIRA Issue Navigator, click the 'Issue Navigator' icon on the GreenHopper Planning Board.
    2. From the 'Tools' menu at the top right of the Issue Navigator, select 'Bulk Change'.
    3. Select the relevant issues and click the 'Next' button.
    4. Select 'Edit Issues' and click the 'Next' button.
    5. Select the 'Component/s' check-box, select just one Component, and click the 'Next' button.
    6. If the 'Confirmation' screen looks as you expect, click the 'Confirm' button.

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

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

5. Flagging an Issue

Flagging a card/issue indicates that it requires special attention. A flagged issue will display a cautionary image on the Task Board.

  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

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

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 'PLANNING BOARD' field, select the project in which you are interested.
  3. In the 'View' field, select 'Version' (or 'Component' or 'Assignee — whichever is most relevant to the issues you need to schedule/assign).
  4. 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.

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

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

10. 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.
  5. Click the 'Recompute' link.

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

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

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

13. 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 the GreenHopper Forum, or solve specific problems at our support portal http://support.atlassian.com.

  • No labels