Connecting Jira Cloudedit

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 Connectoredit

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. Provide the host for your Workplace Search deployment.

This varies with the user interface you are using to manage Enterprise Search. Enterprise Search in Kibana will use your Kibana host and standalone Enterprise Search will use the Enterprise Search host. See user interfaces for details on each UI.

If you are using standalone Enterprise Search, you will use your Enterprise Search host.

Standalone Enterprise Search 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:443/ws/sources/jira_cloud/create

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

If you are using Enterprise Search in Kibana, you will use your Kibana host. This is the same host you set in kibana.external_url in your enterprise-search.yml.

Enterprise Search in Kibana Examples:

# Deployment using a custom domain name for Kibana
https://www.example.com/app/enterprise_search/workplace_search/sources/added

# Deployment using a default Elastic Cloud domain name for Kibana
https://c3397e558e404195a982cb68e84fbb42.kb.us-east-1.aws.found.io:443/app/enterprise_search/workplace_search/sources/added

# Unsecured local Kibana environment
http://localhost:5601/app/enterprise_search/workplace_search/sources/added

Once you have set the host click Create new link:

Figure 53. Connecting Jira

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 54. 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 55. 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 Searchedit

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 permissionsedit

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.

Synchronized fieldsedit

The following table lists the fields synchronized from the connected source to Workplace Search. The attributes in the table apply to the default search application, as follows:

  • Display name - The label used when displayed in the UI
  • Field name - The name of the underlying field attribute
  • Faceted filter - whether the field is a faceted filter by default, or can be enabled (see also: Customizing filters)
  • Automatic query refinement preceding phrases - The default list of phrases that must precede a value of this field in a search query in order to automatically trigger query refinement. If "None," a value from this field may trigger refinement regardless of where it is found in the query string. If '', a value from this field must be the first token(s) in the query string. If N.A., automatic query refinement is not available for this field by default. All fields that have a faceted filter (default or configurable) can also be configured for automatic query refinement; see also Update a content source, Get a content source’s automatic query refinement details and Customizing filters.
Display name Field name Faceted filter Automatic query refinement preceeding phrases

Id

id

No

N.A.

URL

url

No

N.A.

Title

title

No

N.A.

Type

type

Default

None

Slug

slug

No

N.A.

Body

body

No

N.A.

Assigned to

assigned_to

Default

[assigned to]

Created by

created_by

Default

[creator is, created by, edited by, modified by]

Status

status

Default

[with status, status is, in state, '']

Priority

priority

Default

[with priority, priority is]

Comments

comments

No

N.A.

Project

project

Default

N.A.

Created at

created_at

No

N.A.

Updated at

updated_at

No

N.A.

Last updated

last_updated

No

N.A.

Size

size

No

N.A.

Issue

issue

No

N.A.

Media type

mime_type

Configurable

None

Extension

extension

Configurable

None