Add/Edit Jira Software Self-Hosted Source - Panel

When you have the required privileges, you can add the content of a (self-hosted) Jira Software instance to your Coveo Cloud organization. The source can be Shared or Private (see Source Permission Types).

For Jira Software 7+ instances, the source can also be of type Secured. Thanks to a new Atlassian API, the source now supports the Jira Software security model by indexing most Jira Software item permission types (see table below) so that in Coveo search results, a user searching for Jira Software content only sees the content to which he has access in Jira Software. The Coveo Jira Plugin for self-hosted Jira Software is however still needed for all permission types in version 6 and to fully support all permission types in version 7.

Supported Jira Software permission types without plugin Jira Software self-hosted instance version
6

7

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 [more]

By default, a Jira Software Self-Hosted source starts a rescan every day at midnight to retrieve Jira item changes (addition, modification, or deletion).

The Jira Software Self-Hosted source does not support refresh. A source rescan is required to update the source content (see Edit a Source Schedule: [SourceName] - Panel).

Source Features Summary

Features Supported Additional information
Jira Software version 6.1 to 7.2.7
Searchable content types

Projects1, issues, comments, attachments, and work logs

Content update Refresh

Rescan or rebuild needed to retrieve:

  • Changes (creation, edition, deletion) on projects

  • Deletion of issues

Rescan
Rebuild
Permission types Secured

Requires the Coveo plugin.

Private
Shared

Note 1: Project metadata is included on the issues of the project, but the projects themselves are not included.

Requirements

Supported Jira Software Versions

Atlassian Jira Software 6.1 to 7.2.1

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.

Jira Software Administrator Account

You must choose which Jira Software account the source uses to retrieve the content of your Jira Software instance. The source can only include issues to which the source credentials you supply is granted access to. You must therefore assign the source credentials to all necessary Jira Software permission schemes required to gain access to the issues to include.

When you want to include permissions, you must also grant the Jira Software Administrators global permission to the source credentials (see Managing 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 are not supported.

The action that you must perform before configuring source parameters:

Add or Edit a Jira Software Self-Hosted Source

  1. Ensure your Jira Software instance meets the source requirements (see Requirements).

  2. If not already in the Add/Edit a Jira Software Self-Hosted Source panel, go to the panel:

    • To add a source, in the main menu, under Content, select Sources > Add source button > Jira Software > Jira Software Self-Hosted.

      OR

    • To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.

  3. In the Configuration tab:

    1. Under Supported Versions, check if your version of Jira Software is supported.

    2. Under Content Update and Security Requirements:

      1. If not already done, download the Coveo plugin for Jira Software . Click Download Plugin, and then install the plugin or your Jira Software server (see Installing the Coveo Plugin for Atlassian Jira Software).

      2. Enter appropriate values for available parameters:

        • Source name

          A descriptive name for your source under 255 characters (not already in use for another source in this organization).

          JiraCloud-CompanyXYZ

        • Instance URL

          The base URL of the Jira Software instance that you want to include the content.

          http://MyJiraServer:8080/

        • Security

          Select who can see items from this source in a search interface that includes this source in its scope (see Source Permission Types):

          • Shared: Everyone

            OR

          • Private: Only you, when you are authenticated to the search interface with the identity with which you create the source.

            OR

          • Secured - Only users authenticated in the search interface can see the source items for which they have read permission.

            If you want to create a secured source to use with the Coveo On-Premises Crawling Module, contact the Coveo Support team (see Coveo On-Premises Crawling Module).

        Authentication section

        • Username

          Enter the username of a dedicated Jira Software account with the Jira Software Administrators global permission.

          When you want to only index public Jira Software content, enter the credentials of an account that only has access to unsecured content.

        • Password

          Type in the corresponding password.

        Content to include section

        Consider changing the default value of the parameters in this section when you want to fine-tune how your Jira Software site is crawled:

        • Unselect one or more of the following Options when you want to prevent specific Jira Software items from being included:

          By default, all content under the Jira Software domain is included.

          • Attachments (binary files attached to an issue)

          • Comments (on issues)

            • Comment permissions

              The option is cleared by default. When you select the checkbox, the comments will be indexed as an individual item instead of being a metadata on the parent Jira Software comment item itself.

          • Work logs (time entry on an issue)

  4. In the Configuration Access tab, determine whether each group and API key can view or edit the source configuration. In the Access Level column, select View or Edit for each available group. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

    You can select an access level for the groups you are allowed to edit only (see Privileges and Groups Privilege). Groups that you are not allowed to edit are grayed out.

    If you remove the Edit access level from all the groups of which you are a member, you will not be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.

  5. Optionally, consider editing or adding mappings (see Edit the Mappings of a Source: [SourceName]).

    You can only manage mapping rules once you build the source (see Add/Edit a Source - Panel).

  6. Complete your source addition or edition:

    • Click Add Source/Save 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.

      In the Sources page, you need to click Start initial build or Start initial rebuild in the source Status column to respectively add the source content and make your changes effective.

      OR

    • Click Add and Build Source/Save and Rebuild Source when you are done editing the source and want to make changes effective.

      Back in the Coveo Cloud administration console Sources page, you can review the progress of your Jira Software Self-Hosted source addition or modification (see Sources - Page).

  7. Once the source is built or rebuilt, you can review its content in the content browser (see Content Browser - Page).

What’s Next?