Add or Edit a Jira Software Cloud Source

When you have the required privileges, you can add the content of a Jira Software Cloud 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 Cloud version Latest cloud version
Searchable content types

Projects, issues, comments, attachments, and work logs

Content update operations Refresh check

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 check Takes place every day by default.
Rebuild check
Content security options Determined by source permissions check Requires installing the Coveo User Sync app in your instance. Contact us if you are using a non-US or HIPAA organization.
Source creator check
Everyone check
Note

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.

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 (platform-eu | platform-au) page, click the desired source, and then click Edit in the Action bar.

A Jira Software Cloud source indexes cloud content. If you want to retrieve on-premises (server) content, see Add or Edit a Jira Software Server 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.

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

Note

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.

API Token

Enter an API token created with the specified Atlassian account.

Character Optical 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.

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

Note

In US and non-HIPAA organizations, before you select Determined by source permissions, ensure to install the Coveo User Sync app in your instance. In other organizations, contact us. We’ll assist you in enabling the Determined by source permissions option.

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

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?

What's next for me?