Add or Edit a Jira Software Cloud Source

Members of the Administrators and Content Managers built-in groups can add the content of a Jira Software Cloud instance to a Coveo organization. In a Coveo-powered search interface, the source content is accessible to either everyone or the source creator only (see Content Security).

Source Key Characteristics

Features Supported Additional information
Jira Software Cloud version Latest cloud version
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
Source creator
Everyone

Note 1: Project metadata is included on the issues of the project, but the projects themselves aren’t indexed. Issues in a private project are indexed if the crawling account is allowed to access this project. However, since Coveo doesn’t support indexing Jira Software Cloud permissions, the issues in this project will be accessible to all search interface users or to you only, depending on the content security option you select.

Add or Edit a Jira Software Cloud Source

When adding a source, select the Jira Software Cloud option.

To edit a source, on the Sources page, click the desired source, and then, in the Action bar, click Edit.

A Jira Software Cloud source indexes cloud content. If you want to retrieve on-premises (server) content, see Add or Edit a Jira Software Self-Hosted Source instead.

“Configuration” Tab

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

General Information

Source Name

Enter a name for your source.

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 Cloud instance that you want to index. It should contain either jira.com or atlassian.net.

Atlassian Account

Enter the email address of a dedicated Atlassian account with read access to the items that you want to include.

API Token

Enter an API token created with the specified Atlassian account.

Character Optical Recognition (OCR)

Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images. 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.

“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.

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 Start initial 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.

Source Update Best Practice

You can get the JIRA_UNREACHABLE_SERVER error message when your Jira Software Cloud source rebuilds or is scheduled to perform a rescan during the daily Atlassian Cloud maintenance window (1 AM to 3 AM, in your server’s time zone). During this period, Atlassian may block access to the API while performing maintenance tasks.

If possible, schedule your source’s rescans so that they’re completed outside of the daily maintenance window. If not possible, ignore the errors. The next scheduled rescan outside the maintenance window shall complete normally.

What’s Next?

Adapt the source update schedule to your needs.

Recommended Articles