For new users, we recommend using our Elasticsearch-native tools, rather than the standalone Workplace Search product. See this blog post for more information about upgrading your internal knowledge search, to make it an amazing experience for your users!

« Connecting Jira Cloud Network drives connector package »

› ›

Connecting Jira Server

edit

Connecting Jira Server

edit

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

Atlassian Jira is an 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, Content, Size, Type, Project, Collaborators and timestamps

Workplace Search supports Jira Server versions: 8.6.1, 8.3.1

Configuring the Jira Server Connector

edit

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. Head to the Jira Server administrative console and log in.

Step 3. Click the Gear in the top right corner and select Applications:

Figure 65. Connecting Jira

Step 4. Locate Application Links in the sidebar menu.

Provide the host for your Workplace Search deployment. This is the base URL of your Kibana instance.

Once you have set the host click Create new link:

Figure 66. Connecting Jira

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

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

Figure 67. 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 6. A final modal appears:

Figure 68. 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 Server Base URI. Do not include a trailing slash.

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

Connecting Jira Server to Workplace Search

edit

Once the Jira Server connector has been configured, you may connect a Jira Server 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 Server in the Configured Sources list, and follow the Jira Server authentication flow as presented.

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

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

Synchronized fields

edit

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 preceding 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

« Connecting Jira Cloud Network drives connector package »