This page last changed on May 26, 2010 by edawson.

This page explains how to use the bundled gadgets in Crucible.

On this page:

Overview of Crucible Gadgets

As of the release of Crucible 2.3, you can show Crucible data in other Atlassian applications such as JIRA and Confluence by way of special gadgets.

Crucible has three gadgets bundled with it by default:

Gadget Name Description and Gadget URL
'To Do Gadget' This gadget is a list of Crucible to-do items including reviews to do, comments to read or reviews to summarise.

The URL for this gadget is as follows:
http://HOSTNAME:8060/rest/gadgets/1.0/g/com.atlassian.fecru.fecru-gadgets-plugin:overdueReviews/gadgets/todo.xml

In this example, HOSTNAME:8060 is the hostname of your Crucible instance.

'Hassle Gadget' This gadget shows you who you are still waiting on, in other words which reviewers haven't completed your reviews.

The URL for this gadget is as follows:
http://HOSTNAME:8060/rest/gadgets/1.0/g/com.atlassian.fecru.fecru-gadgets-plugin:overdueReviews/gadgets/hassle.xml

In this example, HOSTNAME:8060 is the hostname of your Crucible instance.

'Overdue Reviews Gadget' This gadget shows you reviews that are yet to be completed in the project, across all authors. This is useful for managers or team leads.

The URL for this gadget is as follows:
http://HOSTNAME:8060/rest/gadgets/1.0/g/com.atlassian.fecru.fecru-gadgets-plugin:overdueReviews/gadgets/overdueReviews.xml

In this example, HOSTNAME:8060 is the hostname of your Crucible instance.

Review Coverage This gadget shows content from the innovative Review Coverage report, letting you investigate how much of your codebase has been under code review.

The URL for this gadget is as follows:
http://HOSTNAME:8060/rest/gadgets/1.0/g/com.atlassian.fisheye.review-coverage-report/gadget/recent-changesets.xml

In this example, HOSTNAME:8060 is the hostname of your Crucible instance.

Configuring gadgets is a three phase process. Firstly, you add your JIRA instance as an OAuth consumer. Secondly, you'll add the gadget to the destination application, then finally you add the gadget to the application's dashboard. In our example, we will show how to configure the Crucible gadgets for use in JIRA.

Gadget Configuration 1: Add JIRA to FishEye as an OAuth consumer

Firstly, you need to add JIRA to FishEye as an OAuth consumer. To do this, open the Admin Screen, then click 'Open Authentication (OAuth)' under 'Global Settings' in the left navigation bar. The OAuth configuration screen opens. Click 'Add OAuth Consumer'.

Screenshot: The OAuth Administration Screen


Now, copy the URL for your JIRA instance into the field labelled 'Consumer Base URL' then click 'Add'. The application in use (JIRA or Confluence) will be auto-detected.

Screenshot: Adding Consumers to OAuth


Once the instance is added correctly, it will appear in the list of consumers. From here, you're ready to move onto step two.

Screenshot: List of OAuth Consumers

Gadget Configuration 2: Add Gadget to your Application's Gadget Directory

As a JIRA administrator you allow the use of these gadgets by adding them to the Gadget Directory. For each gadget, you will need to complete and enter the URL listed in the table above.

See the JIRA documentation for details on this process.

Gadget Configuration 3: Add Gadget to the Application's Dashboard

Finally, as a JIRA user, you need to add the gadget to your dashboard:

See the JIRA documentation for details on this process.

Once complete, the gadget will appear on your JIRA dashboard and display information drawn from Crucible and FishEye.

Confluence also allows gadgets to be added to its dashboard. See the General Gadgets Documentation for more information.



Screenshot: The 'To Do' Gadget

Screenshot: The Hassle Gadget

Screenshot: The Overdue Reviews Gadget

Screenshot: The Changeset Review Coverage Gadget


Document generated by Confluence on Jul 29, 2010 20:00