This documentation relates to Gadgets and Dashboards 3.0.x
If you are using an earlier version, please view the previous versions of the Gadgets documentation and select the relevant version.

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

Compare with Current View Page History

« Previous Version 10 Next »

This page is a DRAFT and is visible to Atlassian staff only.

This page lists all the Atlassian gadgets that allow you to obtain information from an Atlassian application and display it on a page in the same or another site. We tell you a bit about each gadget and how to use it on a JIRA dashboard and a Confluence page, linking to the gadget-specific documentation where relevant.

On this page:

Displaying Bamboo Data in a Gadget

Bamboo Charts

Gadget Name:

Bamboo Charts

Description:

Displays various charts and plan statistics from a particular Bamboo server.

Publishing Server:

Bamboo. The gadget URL addresses the Bamboo server.

Application Version on Publishing Server:

Bamboo 2.4 and later.

Usage in JIRA:

You need Bamboo and JIRA. Summary of steps:

Usage in Confluence:

You need Bamboo and Confluence. Summary of steps:
Example of Gadget URL
http://bamboo.example.com:8085/rest/gadgets/1.0/g/com.atlassian.bamboo.gadgets/charts/bambooCharts.xml

Bamboo Plan Summary Chart

Gadget Name:

Bamboo Plan Summary Chart

Description:

Displays a graphical summary of a Bamboo build plan.

Publishing Server:

Bamboo. The gadget URL addresses the Bamboo server.

Application Version on Publishing Server:

Bamboo 2.4 and later.

Usage in JIRA:

You need Bamboo and JIRA. Summary of steps:

Usage in Confluence:

You need Bamboo and Confluence. Summary of steps:

Example of Gadget URL:

http://bamboo.example.com:8085/rest/gadgets/1.0/g/com.atlassian.bamboo.gadgets/charts/planSummaryChart.xml

Bamboo Plan Status

Gadget Name:

Bamboo Plans

Description:

Displays a list of all plans on a Bamboo server and the status of each plan.

Publishing Server:

Bamboo. The gadget URL addresses the Bamboo server.

Application Version on Publishing Server:

Bamboo 2.4 and later.

Usage in JIRA:

You need Bamboo and JIRA. Summary of steps:

Usage in Confluence:

You need Bamboo and Confluence. Summary of steps:

Example of Gadget URL:

http://bamboo.example.com:8085/rest/gadgets/1.0/g/com.atlassian.bamboo.gadgets/status/planStatus.xml

Displaying Clover Data in a Gadget

Clover Coverage

Gadget Name:

Clover Coverage

Description:

Displays the Clover code coverage for plans from a particular Bamboo server.

Publishing Server:

Bamboo. The gadget URL addresses the Bamboo server. This gadget is published by the Clover plugin for Bamboo.

Application Version on Publishing Server:

Bamboo 2.4 and later.

Usage in JIRA:

You need Bamboo with the Clover plugin, and JIRA. Summary of steps:

Usage in Confluence:

You need Bamboo with the Clover plugin, and Confluence. Summary of steps:

Example of Gadget URL:

http://bamboo.example.com:8085/rest/gadgets/1.0/g/com.atlassian.bamboo.gadgets/status/cloverCoverage.xml

Displaying Confluence Data in a Gadget

Confluence Activity Stream

Gadget Name:

Activity Stream

Description:

Displays recently-updated content from a Confluence site.

Publishing Server:

Confluence. The gadget URL addresses the Confluence server.

Application Version on Publishing Server:

Confluence 3.1 and later.

Usage in JIRA:

You need Confluence and JIRA. Summary of steps:

Usage in Confluence:

You can use this gadget to display Confluence data within the same site. Just add the gadget to a wiki page via the macro browser. See the Confluence user's guide.

You can also use the gadget to display information from one Confluence site ('A') on another Confluence site ('B'). Summary of steps:

  • Configure Confluence site 'A' to trust Confluence site 'B' as an OAuth consumer or as a trusted application. See the Confluence administrator's guide on OAuth and Trusted Applications.
  • Add the gadget URL to the list of authorised external gadgets on Confluence site 'B'. See the Confluence administrator's guide.
  • Add the gadget to a wiki page on Confluence site 'B' via the macro browser. See the Confluence user's guide.

Example of Gadget URL:

http://confluence.example.com:8090/rest/gadgets/1.0/g/com.atlassian.streams.confluence:activitystream-gadget/gadgets/conf-activitystream-gadget.xml

Confluence QuickNav

Gadget Name:

Confluence QuickNav

Description:

Provides the Confluence Quick Navigation Aid functionality for searching the Confluence site.

Publishing Server:

Confluence. The gadget URL addresses the Confluence server.

Application Version on Publishing Server:

Confluence 3.1 and later.

Usage in JIRA:

You need Confluence and JIRA. Summary of steps:

Usage in Confluence:

You need just Confluence. You can use this gadget to display Confluence data within the same site. Just add the gadget to a wiki page via the macro browser. See the Confluence user's guide.

You can also use the gadget to display information from one Confluence site ('A') on another Confluence site ('B'). Summary of steps:

  • Configure Confluence site 'A' to trust Confluence site 'B' as an OAuth consumer or as a trusted application. See the Confluence administrator's guide on OAuth and Trusted Applications.
  • Add the gadget URL to the list of authorised external gadgets on Confluence site 'B'. See the Confluence administrator's guide.
  • Add the gadget to a wiki page on Confluence site 'B' via the macro browser. See the Confluence user's guide.

Example of Gadget URL:

http://confluence.example.com:8090/rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:gadget-search/gadgets/gadget-search.xml

Displaying Confluence News in a Gadget

Confluence News

Gadget Name:

Confluence News

Description:

Displays news items about Confluence from the Atlassian Blog.

Publishing Server:

Atlassian website. The gadget URL addresses a page on the Atlassian web server.

Application Version on Publishing Server:

N/A

Usage in JIRA:

You need just JIRA. Summary of steps:

Usage in Confluence:

You need just Confluence. Summary of steps:

Gadget URL:

http://www.atlassian.com/gadgets/confluence-news.xml

Displaying Crowd Data in a Gadget (None)

We do not yet have any gadgets that display Crowd data.

Displaying Crucible Data in a Gadget

Crucible Charts

Gadget Name:

Crucible Charts

Description:

Displays charts showing statistical summaries of code reviews.

Publishing Server:

JIRA. The gadget URL addresses the JIRA server. This gadget is published by the FishEye plugin for JIRA.

Application Version on Publishing Server:

JIRA 4.0 and later.

Usage in JIRA:

You need Crucible and JIRA. Summary of steps:

Usage in Confluence:

You need JIRA, Crucible and Confluence. Summary of steps:

Example of Gadget URL:

http://jira.example.com:8080/rest/gadgets/1.0/g/com.atlassian.jirafisheyeplugin:crucible-charting-gadget/gadgets/crucible-charting-gadget.xml




To be continued...


Displaying FishEye Data in a Gadget

  • Charts 
    http://jira.example.com:8080/rest/gadgets/1.0/g/com.atlassian.jirafisheyeplugin:fisheye-charting-gadget/gadgets/fisheye-charting-gadget.xml
    JIRA URL. This gadget is published by the FishEye plugin for JIRA.
    You can add it to a Confluence page, provided you have JIRA, using the gadget URL in the usual manner.
    Tested in Confluence in Dragons 2, this page.
  • Recent Changesets 
    http://jira.example.com:8080/rest/gadgets/1.0/g/com.atlassian.jirafisheyeplugin:fisheye-recent-commits-gadget/gadgets/fisheye-recent-commits-gadget.xml
    JIRA URL. This gadget is published by the FishEye plugin for JIRA.
    You can add it to a Confluence page, provided you have JIRA, using the gadget URL in the usual manner.
    Tested in Confluence in Dragons 2, this page.

Displaying GreenHopper Data in a Gadget

  • Agile Gadget 
    http://jira.example.com:8080/rest/gadgets/1.0/g/com.pyxis.greenhopper.jira:greenhopper-gadget-project-dashboard/gadgets/greenhopper-project-dashboard.xml
    JIRA URL. Published via the GreenHopper plugin in JIRA.
    Tested in Confluence on EAC. (tick)

Displaying JIRA Data in a Gadget

Finding a Gadget's URL

Often you will need to add a gadget to a directory by copying and pasting the gadget URL. Here are some guidelines.

A gadget's URL points to the gadget's XML specification file. In general, a gadget's URL looks something like this:
http://example.com/my-gadget-location/my-gadget.xml

If the gadget is supplied by a plugin, the URL will have this format:
http://my-app.my-server.com:port/rest/gadgets/1.0/g/my-plugin.key:my-gadget/my-path/my-gadget.xml
For example:
http://mycompany.com/jira/rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml

To find a gadget's URL in JIRA:

  • Go to your dashboard by clicking the Dashboards link at the top left of the screen.
  • Click Add Gadget to see the list of gadgets in the directory.
  • Find the gadget you want, using one or more of the following tools:
    • Use the scroll bar on the right to move up and down the list of gadgets.
    • Select a category in the left-hand panel to display only gadgets in that category.
    • Start typing a key word for your gadget in the Search textbox. The list of gadgets will change as you type, showing only gadgets that match your search term.
  • Right-click the Gadget URL link for that gadget and copy the gadget's URL into your clipboard.

To find a gadget's URL in Confluence:

  • Choose Help > Confluence Gadgets to see the list of available Confluence gadgets.
  • Find the gadget you want.
  • Right-click the Gadget URL link for that gadget and copy the gadget's URL into your clipboard.
  • No labels