IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Connecting Google Drive Connecting Jira Server »
Elastic Docs › ›Content Sources Overview

Connecting Jira Cloud

edit

Connecting Jira Cloud

edit

Enterprise Search versions 7.15.0 and later are required to connect to Jira Cloud. This is due to backwards incompatible API changes introduced by Atlassian, the developer of Jira Cloud.

Additionally, the following patch versions of Enterprise Search are not compatible with Jira Cloud: 7.17.2, 8.1.1, and 8.1.2. This is due to additional, backwards incompatible API changes introduced by Atlassian.

Instructions provided in this guide apply to Jira Cloud only. Refer to Jira Server guide for more information.

Atlassian Jira is a issue tracking product that provides bug tracking, workflow automation, and agile project management tools for teams of all sizes. The Jira Server connector provided with Workplace Search automatically captures, syncs and indexes the following items:

Epics

Including ID, Content, Type, and timestamps

Projects

Including ID, Content, Type, Slug and timestamps

Issues

Including ID, Content, Status, Priority, Comments, Project, Slug, Collaborators and timestamps

Attachments

Including ID, Size, Type, Comments, Project, Collaborators and timestamps

Configuring the Jira Cloud Connector

edit

Configuring the Jira Cloud connector is the first step prior to connecting the Jira Cloud service to Workplace Search, and requires that you create an OAuth App from the Jira Cloud platform.

Step 1. From the Workplace Search administrative dashboard’s Sources area, locate Jira Server and click Configure. You are presented with a Public Key and a Consumer Key. Copy these keys and keep them handy, as we’ll need them in just a second.

Step 2. Log in to Jira as an administrator. We must manually navigate to Application Links, which are found at:

https://YOUR_JIRA_INSTANCE.atlassian.net/plugins/servlet/applinks/listApplicationLinks

Step 3. Next, enter the host value for your Workplace Search deplyment. Click Create new link:

Figure 64. Connecting Jira

Examples:

# Deployment using a custom domain name
https://www.example.com

# Deployment using a default Elastic Cloud domain name
https://c3397e558e404195a982cb68e84fbb42.ent-search.us-east-1.aws.found.io

# Unsecured local development environment
http://localhost:3002

This operation will fail, and is normal behavior for the time being.

Step 4. Confirm the link, and proceed. A modal appears. Provide the information accordingly:

Figure 65. Connecting Jira
  • Application Name: Elastic Workplace Search
  • Application Type: Generic Application
  • Service Provider Name: Elastic
  • Consumer key, Shared secret, Request Token URL, Access token URL, Authorize URL: Any random value. A simple period will do.
  • Create incoming link: Check this box.

Click Continue.

Step 5. A final modal appears:

Figure 66. Connecting Jira
  • Consumer Key: The Consumer Key from Workplace Search
  • Consumer Name: Elastic
  • Public Key: The Public Key from Workplace Search you’ve previously copied.

Click Continue.

Step 7. Back to the Workplace Search administrative dashboard, enter the appropriate Jira Base URI. Do not include a trailing slash.

Step 8. Save the configuration. Voilà! The Jira Cloud connector is now configured, and ready to be used to synchronize content. In order to capture data, you must now connect a Jira Cloud instance with the adequate authentication credentials.

Connecting Jira Cloud to Workplace Search

edit

Once the Jira Cloud connector has been configured, you may connect a Jira Cloud instance to your organization.

Step 1. Head to your organization’s Workplace Search administrative dashboard, and locate the Sources tab.

Step 2. Click Add a new source.

Step 3. Select Jira Cloud in the Configured Sources list, and follow the Jira Cloud authentication flow as presented.

Step 4. Upon the successful authentication flow, you will be redirected to Workplace Search.

Jira Cloud content will now be captured and will be ready for search gradually as it is synced. Once successfully configured and connected, the Jira Cloud synchronization automatically occurs every 2 hours.

Document-level permissions

edit

You can synchronize document access permissions from Jira Cloud to Workplace Search. This will ensure the right people see the right documents.

See Document-level permissions for Atlassian Cloud.

« Connecting Google Drive Connecting Jira Server »