Use Jira Software As a Content Source

SearchUnify can index the issues stored in Jira Software instances. This article walks you through the process of setting up Jira Software as a content source.

PERMISSIONS.

• You should have access to the projects or spaces to be crawled. Ensure that you have Project Administrator access. This access is required to fetch the permission schema in Jira.

• You must have “Browse Users and Groups” permission. You must be in a group that has global permissions of “Browse Users and Groups” in Atlassian. This is needed to fetch the email and account id of the user to respect permissions.

• The number of responses received from Jira over a given period depend upon the Jira's rate limits. You can find the the latest rate limits on their website.

Establish a Connection

1. Navigate to Content Sources.

   

2. Click Add New Content Source.

   

3. Find Jira from the search box and click Add.

   

4. Give your content source a Name.

   

5. Enter the web address of your Jira Software instance in Client URL.

   

6. Select an Authentication Method.

   RELATED. Which Authentication Method to Select for Jira Software?

   NOTE 1

   The Password field in Basic authentication requires an API token. This article explains how to generate it. Alternative, check out the official Zendesk documentation: Create an API token

   NOTE 2

   OAuth requires the existence of a Jira Software app. Learn how to create one. You can also learn how to create an app from the official Zendesk documentation: Generate an RSA public/private key pair.

   

7. Select the content language and click Connect. If your clients report issues in German, select -de and for French pick -fr. It's possible to set multiple content languages. The default content language is English (-en).

   

Set Up Crawl Frequency

The first crawl is always manual and is performed after configuring the content source. In Choose A Date, select a date to start crawling; the data created after the selected date will be crawled. For now, keep the frequency to its default value Never and click Set and move to the next section.

Select Fields for Indexing

You can index all issue content fields or only a few of them.

1. Click to select content fields.

   

2. From the leftmost column Name add content fields one at a time.

   

3. Once you have finished, click Save.
4. Navigate to By Projects.

   

5. Use the index to find your project and check enable for each one of it. If no project is selected, then all the projects are crawled.

   

6. Press Save.

   

After the First Crawl

Return to the Content Sources screen and click in Actions. The number of indexed documents is updated after the crawl is complete. You can view crawl progress in in Actions. Documentation on crawl progress is in View Crawl Logs.

NOTE 1

Review the settings in Rules if there is no progress in Crawl Logs.

NOTE 2

For Mamba '22 and newer instances, search isn't impacted during a crawl. However, in older instances, some documents remain inaccessible while a crawl is going on.

Once the first crawl is complete, click in Actions open the content source for editing, and set a crawl frequency.

1. In Choose a Date, click to fire up a calendar and select a date. Only the data after the selected date is indexed.

   

2. Use the Frequency dropdown to select how often SearchUnify should index the data. For illustration, the frequency has been set to Weekly and Tuesday has been chosen as the crawling day. Whenever the Frequency is other than Never, a third dropdown appears where you can specify the interval. Also, whenever Frequency is set to Hourly, then manual crawls are disabled.

   

3. Click Set to save crawl frequency settings. On clicking Set, you are taken to the Rules tab.

   

Data Deletion and SU Index

A method to update the index in real time is to enable event subscriptions, which supplement existing crawls and synchronize data between your Jira instance and SearchUnify in real time. The instructions are on Synchronize SearchUnify Index with Jira through Event Subscription

Jira-On-Premises Users.

If your organization uses Jira On-Premises, write to your customer support representative. They will share with you a list of SearchUnify IPs to be whitelisted. Once the IPs have been whitelisted, SearchUnify can crawl the data in your Jira instance.