Install the Coveo plugin for Atlassian Jira Software

This is for:

Developer System Administrator

The Coveo source for Jira Software comes with a Jira Software plugin. When you want to index Jira Software permissions, you must install this plugin on your Jira Software server.

Note

You can’t install the Coveo plugin in Jira Software Cloud. Therefore, it’s not supported to index Jira Software Cloud item permissions.

Install the Coveo Jira Software plugin

  1. Download the Coveo plugin for Jira Software, if not already done:

    1. On the Sources (platform-ca | platform-eu | platform-au) page, access the Add/Edit a Jira Software Server Source panel:

      • If you already have created a Jira Software source, click the source, and then click Edit in the Action bar.

      • If not, click Add source and select the Jira Software Server source for the content retrieval method you want to use.

    2. In the Add/Edit a Jira Software Server Source panel, in the Configuration tab, click Download Plugin, and then select your Jira Software version.

  2. Log in to your Jira Software server using a Jira Software administrator account.

  3. On the menu, select Browse, and then select 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. On the Manage Add-ons page, click the Upload add-on link.

  7. In the Upload add-on dialog box:

    JIRA6-UploadCoveoPlugIn

    1. Click Choose File.

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

    3. Click Upload.

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

    JIRA6-UploadCoveoPlugIn2

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

Uninstall the Coveo Jira Software plugin

  1. Log in to your Jira Software server using a Jira Software administrator account.

  2. On the menu, select Browse, and then select 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.

    JIRA6-UploadCoveoPlugIn3

  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.

What’s next?

Create a Jira Software Server source and enter the credentials of the Jira Software administrator account in the Authentication section (see Add a Jira Software Server source).