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 your Coveo Cloud organization. The source can be Shared or Private (see Source Permission Types).

By default, a Jira Software Cloud source starts a rescan every hour to retrieve Jira Software Cloud item changes (addition, modification, or deletion).

  • The Jira Software Cloud source does not support refreshes. A source rescan is required to update the source content (see Edit a Source Schedule).

  • You can get the Jira_UNREACHABLE_SERVER error message when your Coveo Cloud Jira Software Cloud source rebuilds or is scheduled to perform a rescan during the Atlassian Jira Software Cloud (1 AM to 3 AM daily) maintenance window during which Atlassian may block access to the API while performing maintenance tasks (see Maintenance windows).

    If possible, schedule rescans to start and complete outside of the daily maintenance window (see Edit a Source Schedule). If not possible, simply ignore the errors. The next scheduled rescan outside the maintenance window shall complete normally.

Source Features Summary

Features Supported Additional information
Jira Software Cloud version Latest cloud version
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
Private
Shared

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

Add or Edit a Jira Software Cloud Source

  1. If not already in the Add/Edit a Jira Software Cloud 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 Cloud.

      OR

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

  2. In the Configuration tab, 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 Cloud instance that you want to include the content.

      A Jira Software Cloud instance URL must contain either jira.com or atlassian.net.

    • Username

      The username of a dedicated Jira Software Cloud account with read access to the items that you wish to include.

      Remember that Jira Software Cloud permissions are not included, so if you select the source content to be Shared, in search results, search interface users can see all items the dedicated account can access.

    • Password

      The corresponding password.

    • Content 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

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

  3. In the 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 Cloud site is crawled. Deselect one or more of the following Options when you want to prevent specific Jira Software Cloud items from being included:

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

    • Attachments (binary files attached to an issue)

    • Comments (on issues)

    • Work logs (time entry on an issue)

  4. In the 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 Manage Source Mappings).

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

  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 must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.

      • By default, a Jira Software Cloud 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 Edit a Source JSON Configuration and Add Source Filters).

      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 source addition or modification (see Manage Sources).

    Once the source is built or rebuilt, you can review its content in the content browser (see Inspect Items With the Content Browser).

What’s Next?

Review the default refresh schedule in which a source refresh starts every 15 minutes and a rescan starts every day at midnight (see Edit a Source Schedule).