Community

Product DocsMenu

Installing the Coveo Plugin for Atlassian Jira Software

The Coveo connector for Jira Software V2 comes with a Jira Software plugin. When you want to index Jira Software permissions, you must install this plugin on your Jira Software (self-hosted) server.

Notes:

  • Because you cannot add plugins to Jira Software on Atlassian Cloud, it is not possible to index Jira Software Cloud item permissions.

  • When you upgrade CES to a version that contains an updated Jira Software plugin, you must uninstall the old plugin and reinstall the new one. If you do not, you will see an error message similar to the following one:

    The version [n] of Coveo Enhanced REST API is not supported. The minimal required version is [m].

To install the Coveo Jira Software Plugin

  1. From the Coveo Master server, copy the Coveo plugin file ([Index_Path]\Bin\CoveoEnhancedRestApi.jar) and paste it to a location and computer of your choice accessible to the browser that you will use to install the plugin from the Jira Software Manage Add-on page.

    Jira Software version Plugin JAR file
    7.x

    CES 7.0.8541+ (September 2016)

    [Index_Path]\Bin\CoveoEnhancedRestApi7.jar

    6.x [Index_Path]\Bin\CoveoEnhancedRestApi.jar

  2. Log into your Jira Software (self-hosted) server using a Jira Software administrator account.

  3. On the menu, click Browse > Add-ons.

  4. If the Administrator Access dialog box appears, enter your administrator account credentials, and then click Confirm.

  5. In the navigation panel on the left, under Atlassian Marketplace, click Manage Add-ons.

  6. In the Manage Add-ons page, click the Upload add-on link.

  7. In the Upload add-on dialog box:

    1. Click Choose File.

    2. In the Open dialog box, select the Coveo plugin file that you copied on step 1, and then click Open.

    3. Click Upload.

  8. In the Installed and ready to go! dialog box, click Close.

  9. In the User-installed Add-ons list, validate that the Coveo Enhanced REST API Plugin is listed.

To uninstall the Coveo Jira plugin

  1. Log into your Jira Software (self-hosted) server using a Jira Software administrator account.

  2. On the menu, click Browse > Add-ons.

  3. If the Administrator Access dialog box appears, enter your administrator account credentials, and then click Confirm.

  4. In the navigation panel on the left, under Atlassian Marketplace, click Manage Add-ons.

  5. In the User-installed Add-ons list, locate and expand Coveo Enhanced REST API Plugin.

  6. In the Coveo Enhanced REST API Plugin, click Uninstall.

  7. In the Confirm dialog box, click Continue.

  8. Validate the Coveo Enhanced REST API Plugin is no longer listed in the User-installed Add-ons list.

People who viewed this topic also viewed