Documentation for GreenHopper 6.2.x. Documentation for earlier versions of GreenHopper is [available too].

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 45 Next »

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.

NOTE FROM NICK: What if there are no sortable fields already? See Configuring your General Project Settings. There should likely be a link to create a sortable field and a flag field like there is for Ranking Field when none is present (see http://jira.atlassian.com/browse/GHS-1635 ).

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:

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

Unable to render {include} The included page could not be found.

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.

  1. Log in as a user with the 'JIRA Administrators' global permission.
  2. Bring up the JIRA administration page by clicking the 'Administration' menu on the top bar and selecting the 'JIRA Administration' option.
  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

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

Note that you will need the 'JIRA Administrators' global permission and the 'Administer Projects' project permission before you can perform most of the tasks in this section.

  • Adding the "Story" issue type:
    *#
    *#
    *#
  • Configuring a card template for the "Story" issue type:
    *#
    *#
    *#
  • Adding the "Story Point" custom field:
    *#
    *#
    *#
  • Setting up a version hierarchy:
    *#
    *#
    *#
    For more information, please see the documentation.
  • Synchronising versions and components (SHOULD PEOPLE DO A MANUAL SYNC UP-FRONT? OR SHOULD WE JUST GET THEM TO SET UP AUTOMATIC SYNCHRONISATION?):
    *#
    *#
    *#
    For more information, please see the documentation.
  • Setting constraints:
    *#
    *#
    *#
  • Adding the 'Issue Counter' custom field:
    *#
    *#
    *#

The following applies to both Scrum and Kanban.

  • Adding the 'Flag' custom field:
    If you configure a 'Flag' field, a cautionary image will display on the Task Board behind flagged cards. To create a custom field called 'Flag' with the value 'Blocker':
    1. Click the 'Administration' link in the top navigation bar.
    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 Checkboxes, 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 all the issue types used by your GreenHopper projects.
    8. In the 'Choose Applicable Context' field, select either:
      • 'Global' — your 'Flag' field will be visible on all issues in 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. In the 'Associate field Flag to screens' list, select the screen(s) on which your 'Flag' field will be displayed. (If unsure, start with just the 'Default Screen'.)
    11. Click the 'Update' button.
    12. Click the 'Configure' link next to your 'Flag' field.
    13. Click the 'Edit Options' link.
    14. In the 'Add New Custom Field Option' field, type 'Blocker'.
    15. Click the 'Add' button, then the 'Done' button.
  • Adding the 'Rank' custom field:
    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 'Choose Applicable Context' field, select either:
      • 'Global' — your 'Rank' field will be visible on all issues in JIRA.
      • 'Projects' (select the relevant projects) — your 'Rank' field will only be visible on issues in the specified projects.
    6. Accept all the other field defaults on the 'Add Field' page. Click the 'Finish' button.
    7. On the 'Associate field Rank to screens' page, click the 'Cancel' button.
  • Setting the Planning Board's Context to sort by Rank:
    *#
    *#
    *#
  • Changing the card colours:
    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. 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 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 'Administration' in the top navigation bar.
    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. Click the 'Activate' button.
      For more about configuring time-tracking, please see the JIRA documentation.
  • 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' tick-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 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 'Component/s' tick-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

  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. If you wish to see only the issues that are assigned to you, tick the 'My Issues' check-box.

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

4. Creating an Issue

  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 an issue indicates that it requires special attention. A flagged issue will display a cautionary image on the Task 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. 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 helps you organise and prioritise tasks in your product/sprint backlog more effectively.

  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 your project's Ranking field (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

  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

  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

  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

  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.

  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.

  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

  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.

  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.

  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' — the JIRA project for which you want to display GreenHopper data.
    • 'Display chart values' — whether or not you want to view charts in the gadget.
    • '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