Add or Edit a Jira Software Server Source

When you have the required privileges, you can add the content of a Jira Software (Server) instance to a Coveo organization.

Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions.

Source Key Characteristics

Features Supported Additional information

Jira Software version

8

Only the minor versions currently maintained by Atlassian are supported. The latest version to have been tested with Coveo is 8.15.

Searchable content types

check

Projects[1], issues, comments, attachments, and work logs

Content update operations

Refresh

check

A rescan or rebuild is required to retrieve:

  • Changes (creation, modification, deletion) on projects

  • Deletion of issues, and work logs, attachments, and comments on issues

Rescan

check

Takes place every day by default.

Rebuild

check

Content security options

Same users and groups as in your content system

check

Requires the Coveo plugin to index all permission types.
Without the plugin, only some permission types are indexed.

Specific users and groups

check

Everyone

check

Requirements

Supported Jira Software Versions

Atlassian Jira Software 8 is supported.

Jira Software Data Center is supported.

Atlassian Jira Software Server Accessible to Coveo

When the access to communication ports between Coveo and the Jira Software server is restricted, the appropriate port(s) must be opened in the network infrastructure such as in firewalls to allow Coveo to access the content.

Note

Single sign-on (SSO) isn’t supported. If your instance uses an SSO, you must create a native Atlassian crawling account directly in Jira to bypass it and crawl the instance content.

Crawling Account Permissions

When you want to retrieve the content of your Jira Software instance, a crawling account with read permission is required. The source can only include the issues which are accessible by the source credentials you supply. You must therefore assign the source credentials to all necessary Jira Software permission schemes required to gain access to the issues to include.

However, when you want to index permissions along with the content, you must also grant the Jira Administrators global permissions to the source credentials.

Note

When configuring the source, you must use the credentials of a native Jira Software user. Users managed by other identity providers such as Google aren’t supported.

Add or Edit a Jira Software Server Source

When adding a source, in the Add a source of content panel, click the On-Premises (On-premises icon) or the Crawling Module (Crawling Module icon) tab, depending on whether you need to use the Coveo On-Premises Crawling Module to retrieve your content. See Content Retrieval Methods for details.

To edit a source, on the Sources (platform-eu | platform-au) page, click the desired source, and then click Edit in the Action bar.

A Jira Software Server source indexes on-premises (server) content. To retrieve cloud content instead, see Add or Edit a Jira Software Cloud Source.

"Configuration" Tab

In the Add/Edit a Jira Software Server Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

Content Security Requirements

Download and install the Coveo Jira plugin on your Jira Software server if you intend to select the Same users and groups as in your content system content security option. Without the plugin, only some permission types are indexed.

General Information

Source Name

Enter a name for your source.

Tip
Leading practice

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.

Instance URL

Enter the base URL of the Jira Software Server instance that you want to index.

Example

http://MyJiraServer:8080/

Paired Crawling Module

If your source is a Crawling Module source, and if you have more than one Crawling Module linked to this organization, select the one with which you want to pair your source. If you change the Crawling Module instance paired with your source, a successful rebuild is required for your change to apply.

Optical Character Recognition (OCR)

If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

Note

Contact Coveo Sales to add this feature to your organization license.

"Authentication" Section

Enter one of the following:

  • The credentials of a dedicated Jira Software account that has access to the content that you want to index.

  • A personal access token corresponding to this account. However, to use this option, you must have the secure administrator session feature deactivated.

This account must also have the Jira Administrators global permission.

"Content to Include" Section

Some types of data are optional to index. Select the desired content.

Attachments

Check this box to index binary files attached to an issue.

Comments

Check this box to index comments posted on issues. The comments will be indexed as metadata of the Jira Software issue under which they appear.

Check the Comment permissions box to index comments as individual items rather than as metadata of an issue item. The access permissions will also be indexed, which means that only the users allowed to access a comment will be able to find it through a Coveo-powered search interface.

Work Logs

Check this box to index time entries on issues.

"Content Security" Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

"Access" Tab

In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):

  1. If available, in the left pane, click Groups or API Keys to select the appropriate list.

  2. In the Access Level column for groups or API keys with access to source content, select View or Edit.

Completion

  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.

      Note

      On the Sources (platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.

    • When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.

      Back on the Sources (platform-eu | platform-au) page, you can review the progress of your source addition or modification.

      Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings once your source is done building or rebuilding.

    Should you need to create mapping rules for Jira Software custom fields, see this article.

Tip
Leading practice

By default, a Jira Software source indexes the entire Jira Software instance content. If you want to index only certain projects, click Save, and then specify the desired address patterns in your source JSON configuration before launching the initial build. See Add Source Filters for further information.

Permission Types Indexed Without the Coveo Plugin

If you select the Same users and groups as in your content system content security option, you should install the Coveo Jira plugin on your Jira Software server. Without it, only the following permission types are supported:

Jira Software permission types Supported without plugin

Group & user

check

Project

check

Application role

check

Issue-level

x

Attachments

check

Comments

check[2]

Time Tracking

check

What’s Next?


1. Project metadata is included on the issues of the project, but the projects themselves aren’t included.
2. You must activate the option on the source to support permissions on comments.