Add a Jira Software Cloud source

This is for:

Developer System Administrator

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

Indexable content

Jira 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 Jira 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 installing the Coveo User Sync app in your instance. See About the Coveo User Sync App for details.

Specific users and groups

check

Everyone

check
Note

Jira project metadata is included on the issues of the project, but the projects themselves aren’t indexed. Issues in a private Jira project are indexed if the crawling account is allowed to access this project.

Requirements

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 a Jira Software Cloud source

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

Tip
Leading practice

It’s best to create or edit your source in your sandbox organization first. Once you’ve confirmed that it indexes the desired content, you can copy your source configuration to your production organization, either with a snapshot or manually.

See About non-production organizations for more information and best practices regarding sandbox organizations.

  1. On the Sources (platform-ca | platform-eu | platform-au) page, click Add source.

  2. In the Add a source of content panel, click the Jira Software Cloud (cloud-icon) source tile.

  3. In the Add a new Jira Cloud source panel, provide the following information:

    • Name: The source name can’t be modified once it’s saved. Therefore, make sure to use a short and descriptive name, using letters, numbers, hyphens, and underscores. Avoid spaces and other special characters.

    • Jira address: The URL of your Jira root URL. It often ends with jira.com.

    • Authentication: How Coveo should log in to your Jira Software project to index your content.

      If you select User delegated access using OAuth 2.0

      1. Click Authorize account, and then sign in to Jira Software with an account that has the necessary permissions to access all the content that you want to index.

      2. Click Accept to grant Coveo access to this Jira Software account.

      3. Click Add source.

      The Coveo OAuth 2.0 application requires read scopes only.

      If you select Atlassian account

      1. Create an Atlassian account dedicated to the source. This account must have access to all the content that you want to index. See Source credentials leading practices for other leading practices to follow.

      2. With this account, create an API token. This token should also be dedicated to your source.

      3. Provide Coveo with the email address and API token corresponding to the source’s Atlassian account.

      4. Install the Coveo User Sync app in your Jira Software project to synchronize users and groups with Coveo.

      5. Click Add source.

      If you select No login

      1. Click Next.

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

      3. Click Add source.

    • Project (available with the Enterprise edition): Use the Project selector to associate your source with one or multiple Coveo project(s).

      Note

      After source creation, you can update your Coveo project selection under the Identification subtab.

"Configuration" tab

When configuring or editing your Jira Software Cloud source, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters that let you specify the content to index.

"Content to index" subtab

The Content to index subtab lets you define the content that you want to make available as search results.

Additional content

Optionally, you can index the files attached to the indexed issues and comments.

You can also index comments posted on issues. These comments will be indexed as metadata of this content.

Moreover, you can index work logs from time entries on indexed issues.

"Advanced settings" subtab

The Advanced settings subtab lets you customize the Coveo crawler behavior. All advanced settings have default values that are adequate in most use cases.

Content and images

If you want Coveo to extract text from image files or PDF files containing images, enable the appropriate option.

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

"Authentication" subtab

The Authentication subtab contains settings used by the source crawler to emulate the behavior of a user authenticating to access restricted Jira Software content. You provided authentication information when you created the source.

Jira address: The URL of your Jira root URL. It often ends with jira.com.

Authentication: How Coveo should log in to your Jira Software project to index your content.

If you select User delegated access using OAuth 2.0

  1. Click Authorize account, and then sign in to Jira Software with an account that has the necessary permissions to access all the content that you want to index.

  2. Click Accept to grant Coveo access to this Jira Software account.

The Coveo OAuth 2.0 application requires read scopes only.

If you select Atlassian account

  1. Create an Atlassian account dedicated to the source. This account must have access to all the content that you want to index. See Source credentials leading practices for other leading practices to follow.

  2. With this account, create an API token. This token should also be dedicated to your source.

  3. Provide Coveo with the email address and API token corresponding to the source’s Atlassian account.

  4. Install the Coveo User Sync app in your Jira Software project to synchronize users and groups with Coveo.

If you select No login

Go to the Content security tab, and then select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content security.

"Identification" subtab

The Identification subtab contains general information about the source.

Name

The source name. It can’t be modified once it’s saved.

Project

If you have the Enterprise edition, use the Project selector to associate your source with one or multiple Coveo projects.

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

Notes

  • The Same users and groups as in your content system option requires you to install the Coveo User Sync app in your instance. Install the version of the app that corresponds to the region of your Coveo organization, or install the HIPAA version for Coveo HIPAA environments. See About the Coveo User Sync App for details.

  • In order to implement the above option and index these permissions, you must provide the credentials of a Jira Administrator account in the Configuration tab, under Authentication.

"Access" tab

In the Access tab, set whether each group (and API key, if applicable) in your Coveo organization can view or edit the current source.

For example, when creating a new source, you could decide that members of Group A can edit its configuration while Group B can only view it.

See Custom access level for more information.

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.

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

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

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

      Back on the Sources (platform-ca | platform-eu | platform-au) page, you can follow 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. Once your source is done building or rebuilding, review the metadata Coveo is retrieving from your content.

    1. On the Sources (platform-ca | platform-eu | platform-au) page, click your source, and then click More > View and map metadata in the Action bar.

    2. If you want to use a currently not indexed metadata in a facet or result template, map it to a field.

      1. Click the metadata and then, at the top right, click Add to Index.

      2. In the Apply a mapping on all item types of a source panel, select the field you want to map the metadata to, or add a new field if none of the existing fields are appropriate.

        Notes

        • For details on configuring a new field, see Add or edit a field.

        • For advanced mapping configurations, like applying a mapping to a specific item type, see Manage mappings.

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

      3. Click Apply mapping.

    3. Depending on the source type you use, you may be able to extract additional metadata from your content. You can then map that metadata to a field, just like you did for the default metadata.

      More on custom metadata extraction and indexing

      Some source types let you define rules to extract metadata beyond the default metadata Coveo discovers during the initial source build.

      For example:

      Source type Custom metadata extraction methods

      Push API

      Define metadata key-value pairs in the addOrUpdate section of the PUT request payload used to upload push operations to an Amazon S3 file container.

      REST API
      and
      GraphQL API

      In the JSON configuration (REST API | GraphQL API) of the source, define metadata names (REST API | GraphQL API) and specify where to locate the metadata values in the JSON API response Coveo receives.

      Database

      Add <CustomField> elements in the XML configuration. Each element defines a metadata name and the database field to use to populate the metadata with.

      Web

      Sitemap

      Some source types automatically map metadata to default or user created fields, making the mapping process unnecessary. Some source types automatically create mappings and fields for you when you configure metadata extraction.

      See your source type documentation for more details.

    4. When you’re done reviewing and mapping metadata, return to the Sources (platform-ca | platform-eu | platform-au) page.

    5. To reindex your source with your new mappings, click Launch rebuild in the source Status column.

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

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.

About the Coveo User Sync app

Installing Coveo’s User Sync app in your Atlassian instance is required to replicate your instance’s content access permissions in your search interface. This lets users see in their Coveo search results the content that their role allows them to see in your Atlassian instance.

To replicate your instance’s permission system, Coveo must associate user email addresses with user roles. Atlassian’s API doesn’t provide this information, but provides the roles assigned to each user account ID. So, Coveo built the User Sync app to retrieve the email address corresponding to each user account ID. It can then combine this information with the roles and account IDs provided by Atlassian’s API.

Should you ever switch your source’s content security setting from Everyone to Same users and groups as in your content system, you’ll need to refresh the security identity provider after installing the app.

For more information on sources that index permissions and on how Coveo handles these permissions, see Coveo management of security identities and item permissions.

OAuth 2.0 scopes

The Coveo OAuth 2.0 application requires the following scopes:

  • read:jira-work

  • read:jira-user

  • read:issue-security-level:jira

  • read:project-role:jira

  • read:field:jira

  • read:user:jira

  • read:license:jira

  • read:group:jira

  • read:avatar:jira

  • read:me

Required privileges

You can assign privileges to allow access to specific tools in the Coveo Administration Console. The following table indicates the privileges required to view or edit elements of the Sources (platform-ca | platform-eu | platform-au) page and associated panels. See Manage privileges and Privilege reference for more information.

Note

The Edit all privilege isn’t required to create sources. When granting privileges for the Sources domain, you can grant a group or API key the View all or Custom access level, instead of Edit all, and then select the Can Create checkbox to allow users to create sources. See Can Create ability dependence for more information.
Actions Service Domain Required access level

View sources, view source update schedules, and subscribe to source notifications

Content

Fields

View

Sources

Organization

Organization

Edit sources, edit source update schedules, and view the View and map metadata subpage

Content

Fields

Edit

Sources

Content

Source metadata

View

Organization

Organization

What’s next?

Schedule source updates.