Add or edit a Jira Software Server source

This is for:

Developer System Administrator

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

The latest Jira Data Center and Jira Server versions are supported.

Indexable content

Projects[1], 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

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

The latest Jira Data Center and Jira Server versions are 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-ca | 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.

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.

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

See Source credentials leading practices for details.

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.

Note

The Same users and groups as in your content system option requires you to 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 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 connector 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.

      Click for more information about custom metadata extraction and indexing
      Note

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

      For example:

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

      See your connector 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.

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

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 Metadata page

Content

Fields

Edit

Sources

Content

Source metadata

View

Organization

Organization

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.