Configuring Confluence Gadgets for Use in Other Applications

This page tells you how to add a Confluence gadget to another (external) application. The instructions and examples given in this topic focus on adding and using Confluence Gadgets in other web applications.

Atlassian support does not cover gadgets on external sites like iGoogle and Gmail

In principle, you should be able to add Atlassian gadgets to iGoogle, Gmail and other external sites that support OpenSocial gadgets. However, these external integrations are experimental at this stage and we have encountered problems with them. Please do have fun playing around with them, but be aware that Atlassian does not support the use of Atlassian gadgets on iGoogle, Gmail or other external web sites. See the detailed section on gadget limitations.

Gadgets that display information from Atlassian applications, such as Confluence, should be able to run on iGoogle, Gmail and other web applications that provide OpenSocial containers. Below are specific instructions for iGoogle and Gmail. You can experiment by adding a Confluence gadget to other web sites and applications, such as a Ning community like The Content Wrangler.

On this page:

Overview of Adding a Confluence Gadget to Another Web Application

The exact procedure for adding a Confluence gadget depends on the application where you want to add the gadget. The basic steps are the same:

  1. Find the Confluence gadget's URL, i.e. the URL for the gadget's XML specification file.
  2. Ensure one of the following two mandatory (typically one-off) procedures have been conducted:
    • An OAuth relationship between Confluence (as the 'service provider') and the other web application (as the 'consumer') has been established. Refer to Configuring authentication for an application link for more information about OAuth and instructions on establishing these relationships.
    • A Trusted Applications relationship between Confluence and JIRA has been established. Refer to Configuring Trusted Applications in the JIRA documentation for more information about establishing these relationships.
  3. Follow the procedure provided by the external web application where you want to add the Confluence gadget.

Finding a Confluence Gadget's URL

A gadget's URL points to the gadget's XML specification file. These URLs look something like this:

http://example.com/my-gadget-location/my-gadget.xml

To find a Confluence gadget's URL:

  1. Choose the help icon at top right of the screen, then choose Available Gadgets.
  2. Find the gadget you want.
  3. Copy the Gadget URL link to your clipboard.


Screenshot: Finding a gadget's URL


Adding an Atlassian Gadget to iGoogle

You can customise your iGoogle home page by adding gadgets and moving them around on the page.

To add an Atlassian gadget to your iGoogle page:

  1. First find the gadget's URL as described above.
  2. Go to iGoogle and log in if you have a username and password.
  3. Click Add stuff near the top right of the iGoogle page.
  4. The Google gadget directory will appear, showing a list of available gadgets. Click Add feed or gadget in the right-hand panel.
  5. A text box will open, as shown above. Enter or paste the gadget's URL from your clipboard into the textbox and click Add.
  6. Go back to your iGoogle home page. The gadget will appear on your iGoogle page.

Adding an Atlassian Gadget to Gmail

You can add gadgets to the left-hand panel of your Gmail page.

To add an Atlassian gadget to your Gmail page:

  1. First find the gadget's URL as described above.
  2. Log in to Gmail.
  3. Click Settings near the top right of the Gmail page. The Gmail settings page will appear.
  4. Click the Labs tab. The Gmail Labs page will appear. This is a laboratory area or testing ground where Google allows you to use experimental features in Gmail.
  5. Scroll down to find the feature called 'Add any gadget by URL'.
  6. Select the Enable option, as shown here:
  7. Click Save Changes.
  8. A new Gadgets tab will appear on your 'Settings' page. Click the Gadgets tab. The 'Gadgets' page will appear, as shown in the screenshot below.
  9. Enter or paste your gadget's URL into the Add a gadget by its URL box, then click Add.
  10. The gadget will appear in the left-hand panel of your Gmail page, as shown in the screenshot below.



Screenshot: Adding a gadget to Gmail

Limitations and Support

Atlassian support does not cover gadgets on external sites like iGoogle and Gmail

In principle, you should be able to add Atlassian gadgets to iGoogle, Gmail and other external sites that support OpenSocial gadgets. However, these external integrations are experimental at this stage and we have encountered problems with them. Please do have fun playing around with them, but be aware that Atlassian does not support the use of Atlassian gadgets on iGoogle, Gmail or other external web sites. See the detailed section on gadget limitations.

Related Topics

The big list of Atlassian gadgets

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport