Connecting Jira Cloud

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:

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

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

Figure 54. Connecting Jira

Click Continue.

Step 5. A final modal appears:

Figure 55. Connecting Jira

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.

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.