Managing add-ons

Still need help?

The Atlassian Community is here for you.

Ask the community

About add-ons

An add-on is an installable component that supplements or enhances the functionality of Jira in some way. For example, the Jira Calendar Plugin is an add-on that shows the due dates for issues and versions in calendar format. Other add-ons are available for connecting Jira to Bamboo, developing for Jira, and accessing Atlassian support from Jira.

Jira comes with many pre-installed add-ons (called system add-ons). You can install more add-ons, either by acquiring an add-on from the Atlassian Marketplace, or by uploading an add-on from your file system. This means that you can install add-ons that you have developed yourself. For information about developing your own add-ons for Jira, see the Jira Developer documentation.

To enable various Jira Gadgets, see Configuring the default dashboard.

On this page:

You may notice that the terms 'add-on' and 'plugin' both appear in the Atlassian documentation and tools. While the terms are often used interchangeably, there is a difference. A plugin is a type of add-on that can be installed into an Atlassian host application. Plugins are what developers create with the Atlassian SDK. But there are other types of add-ons as well. For example, the JIRA client is an add-on that runs as a separate program rather than as a plugin to JIRA. This documentation uses the term 'add-on' most often.

About the Universal Plugin Manager

The Universal Plugin Manager (UPM) is itself an add-on that you use to administer add-ons from the Jira Administration Console. UPM works across Atlassian applications, providing a consistent interface for administering add-ons in Jira, Confluence, Crucible, Fisheye, Bitbucket Server or Bamboo.

UPM comes pre-installed in Atlassian Cloud applications, and is kept up to date, so you don't need to install or update it yourself. 

You can perform the following tasks through the UPM administration pages:

  • Configure add-on settings
  • Discover and install new add-ons from the Atlassian Marketplace
  • Update your add-ons

For more information on performing other common add-on administration tasks, see the Universal Plugin Manager documentation

Viewing Jira add-ons

  1. Select the Jira icon (, or ) > Settings > Add-ons
  2. Click Manage add-ons

You can use the text field and category menu to filter the add-ons that appear on the page. By default, the page lists add-ons that require administrative action. For Jira Cloud, this includes add-ons available for trial or that are expiring soon.

In addition, you can choose from these other categories:

  • Paid via Atlassian shows the purchased add-ons in the system, whether sold by Atlassian or a third-party vendor. 
  • User-installed add-ons are not included with the stand-alone version of the product and have been bundled with Jira Cloud. These add-ons can be disabled or enabled. Some modules of these add-ons can be disabled or enabled as well, although modules that are integral to the functioning of the add-on cannot be disabled.
  • System add-ons are those that are shipped with the stand-alone version of the product and included in Jira Cloud. These add-ons are integral to your site's functionality and you should not disable them unless instructed to do so by Atlassian support.

You can filter listed add-ons by text match as well. First, select the category of the add-on and enter text to match the add-on name in the Filter visible add-ons box. Text matching is case-insensitive. Click the name of an add-on to view the add-ons details, as described in the following section.

Viewing add-on details

You can view information about an add-on by clicking it in the 'Manage Add-ons' page. The details view for an add-on contains a short description of the add-on as well as controls for configuring the add-on settings and viewing its individual component modules.
 
The add-on details view may include any of these elements: 

  • Getting Started – Opens a documentation page for the add-on, if implemented by the add-on developer.
  • Configure – Click this link to display the configuration settings for the add-on. This link is disabled if the add-on is disabled. Please note that not all add-ons have configurable settings.
  • Enable – Click this button to enable the add-on. This button only appears if the add-on is disabled.
  • Version – The version of the add-on currently installed.
  • Developer – The name of the add-on developer.
  • Plugin key – A unique key that identifies each add-on in the system.
  • n of n modules enabled – A link that displays the number of component modules in the add-on, and of those, how many are enabled, such as '42 of 42'. Click the link to view the modules. This link only appears if the add-on is made up of component modules.

Enabling add-ons

You can enable Jira add-ons in your Jira Cloud instance.

Enabling an add-on

  1. Select the Jira icon (, or ) > Settings > Add-ons
  2. Click Manage add-ons
  3. Find the add-on you want to enable in the add-ons list.
  4. Click on the add-on to display its details view.
  5. Click the Enable button.
    The system displays a progress message for the operation, which may take a moment. Once finished, the Disable button is replaced with Enable.

Subscribing to Jira application add-ons

About add-on subscriptions

While you can't install add-ons to a Jira Cloud instance, you can extend Jira by subscribing to add-ons. The Atlassian Marketplace makes a set of selected add-ons available to users in the cloud.

You can manage your add-on subscriptions from the add-on administration page in the instance.

The management tasks you can perform in the add-on administration page include:

  • Find add-ons you can license in your add-on instance
  • Start a trial and subscribe to an add-on
  • Deactivate an add-on

Viewing available and subscribed add-ons

To see what add-ons are available for your Jira Cloud instance, go to Viewing your Jira add-ons. Add-ons that are available for your instance appear in the Action Required list with a Free Trial button.

The Action Required filter also shows add-ons that have subscriptions due to expire within 30 days, or that have recently expired. Otherwise, you can find a subscribed add-on by selecting the user-installed filter option.

Trying and subscribing to an add-on

In Atlassian Cloud terms, you buy an add-on by subscribing to it. An active add-on subscription activates the features of the add-on in your Jira Cloud instance. To try or subscribe to an add-on, click the Free Trial button next to the add-on in the Manage Add-ons page.

You click this button whether you're ready to subscribe or just want to try the add-on for now. If you do not terminate the trial within the trial period, a subscription for the add-on kicks in. Trials last for a month from the start of your next billing date. After starting a trial, you can stop it from the add-on administration page. 

Although you can re-enable the trial within the original trial period, you cannot try it again beyond the original trial period. At that point, you will only be able to subscribe to the add-on from the Manage Add-ons page.

Canceling an add-on subscription

You can terminate a subscription for an add-on by clicking the Unsubscribe button for the add-on in the Manage Add-ons page. Canceling an add-on takes effect immediately and you will be not refunded. Some add-ons may retain functionality even after the license period ends. If you'd like to completely stop an add-on from appearing in the interface, uninstall it.

Viewing the Jira application add-on audit log

The audit log display administration activities related to add-ons in your Jira Cloud instance. For example, the log displays when add-ons were enabled or disabled and shows the username of the administrator who made the change.

  1. Select the Jira icon (, or ) > Settings > Add-ons
  2. Click Manage add-ons.
  3. The audit log appears with a list of the 25 most recent entries.
  4. Use the arrows to view older entries.
  5. Click the orange RSS icon if you want to receive the audit log activity in an RSS feed.
Last modified on Mar 5, 2018

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.