Add or Edit a Jira Software Server Source

Members of the Administrators and Content Managers built-in groups can add the content of a Jira Software (Server) instance to a Coveo organization. In a Coveo-powered search interface, the source content is accessible to either everyone, the source creator only, or specific users as determined by source permissions (see Content Security). If you select the last option, you may need to install the Coveo Jira Plugin to index all permission types. Without this plugin, the supported permission types are the following:

Jira Software permission types Supported without plugin
Group & user
Project
Application role
Issue-level
Attachments
Comments 1
Time Tracking

Note 1: You must activate the option on the source to support permissions on comments.

Source Key Characteristics

Features Supported Additional information
Jira Software version 8

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

Searchable content types

Projects1, issues, comments, attachments, and work logs

Content update operations Refresh

Takes place every hour by default. 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 Takes place every day by default.
Rebuild
Content security options Determined by source permissions

Requires the Coveo plugin.

Source creator
Everyone

1: Project metadata is included on the issues of the project, but the projects themselves aren’t included.

Requirements

Supported Jira Software Versions

Atlassian Jira Software 8 is supported.

Jira Software Data Center is supported.

Atlassian Jira Software Server Accessible to Coveo Cloud

When the access to communication ports between Coveo Cloud 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 Cloud to access the content.

SSOs aren’t supported, therefore in order to index the content if using an SSO, you must create a native Atlassian crawling account directly in Jira. The SSO will be bypassed.

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 permission to the source credentials (see Manage global permissions).

  • 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 or the Crawling Module 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 page, click the desired source, and then, in the Action bar, click Edit.

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 Determined by source permissions content security option.

General Information

Source Name

Enter a name for your source.

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.

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.

Character Optical Recognition (OCR)

If you want Coveo Cloud 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.

Index

When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

  • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Manage Privileges and Logical Indexes Domain).

  • Once the source is added, you can’t switch to a different index.

“Authentication” Section

Enter the credentials of a dedicated Jira Software account that has access to the content that you want to index. See Source Credentials Leading Practices. 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, determine whether each group and API key can view or edit the source configuration (see Resource Access):

  1. In the Access Level column, select View or Edit for each available group.

  2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

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.

      On the Sources 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.

      OR

    • 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 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. Should you need to create mapping rules for Jira Software custom fields, see this article.

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

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.

What’s Next?

Recommended Articles