Atlassian Jira Software V2 Connector Deployment Overview

The following procedure outlines the steps needed to deploy the Jira Software V2 connector. The steps indicate the order in which you must perform configuration tasks on both the Jira Software and Coveo servers.

To deploy the Jira Software V2 connector

1. Validate that your environment meets the requirements (see Atlassian Jira V2 Connector Requirements).

2. On your Jira Software (self-hosted) server or Jira Software Cloud instance:

   1. Create a webhook (see Creating a Jira Software Webhook).

   2. Optionally, install the Coveo plugin.

      When you want to index permissions, you must install the Coveo Jira Software V2 plugin on your Jira Software (self-hosted) server (see Installing the Coveo Plugin for Atlassian Jira Software).

      Unless you are only indexing anonymously accessible content, it is recommended to index permissions to allow Coveo search interfaces to only show Jira Software documents to which the end-user performing the search has access in Jira.

      Note: Because you cannot add plugins to Jira Software Cloud, it is not possible to index Jira Software Cloud item permissions.

3. On the Coveo server:

   1. Create a user identity.

      The connector will only index issues to which the crawling user identity is granted access to. This means the Jira Software user account used as the crawling user identity must first be assigned to all necessary Jira permission schemes required in order to gain access to the issues to index.

      Notes:

      • When configuring the source, you must use the credentials of a native Jira Software user. Users managed by other identity providers such as Google are not supported.

      • If the crawling user identity is only granted access to a subset of the Jira Software projects, only issues from these projects will be indexed.

      When you want to index permissions, you must also grant Jira Administrators global permission to this user identity (see Managing Global Permissions and Adding a User Identity) .

      Tip: CES 7.0.8225+ (March 2016) If you want to only index public documents, simply create a user identity with any credentials. The connector must have a non-empty user identity.

   2. CES 7.0.7814+ (August 2015) Optionally create an Email security provider

      When an email is defined for each of your users in Jira Software and this email is used to authenticate them in your Coveo search interface, you can create an Email security provider to allow you to map your Jira Software users to their email (see Configuring an Email Security Provider).

   3. Create a security provider.

      When you want to index permissions, you must configure a security provider (see Configuring an Atlassian Jira Software V2 Security Provider).

   4. Create a Jira Software V2 field set.

      It is recommended to import the out-of-the-box Jira V2 field set ([CES_Path]\Bin\Coveo.CES.CustomCrawlers.Jira2.FieldSet.xml to be able to easily add Jira specific facets to your Coveo search interfaces (see Exporting and Importing a Field Set) .

   5. Configure and index the Jira Software V2 source.

      The Coveo connector needs to know details about your Jira Software instance to be able to index its content (see Configuring and Indexing an Atlassian Jira Software V2 Source).