Add or Edit a Jira Software Cloud Source

Members of the Administrators and Content Managers built-in groups can add the content of a Jira Software Cloud instance to a Coveo Cloud organization. In a Coveo-powered search interface, the source content is accessible to either everyone or the source creator only (see Content Security).

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

Source Features Summary

Add or Edit a Jira Software Cloud Source

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

   • Atlassian account

     An email address corresponding to a dedicated Atlassian account with read access to the items that you want to include.

   • API token

     An API token created with the specified Atlassian account (see API tokens).

     Since June 3rd, 2019, due to a change in Atlassian Cloud sites, Jira Software Cloud sources require an Atlassian account and an API token instead of a native user account and a password for authentication. If you have not yet edited your Jira Software Cloud source to provide this information, you should do it as soon as possible so that your source continues to retrieve Jira Software Cloud content.

   • Character optical recognition (OCR)

     Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View (see Search Result Quick View).

     Since the OCR feature is available at an extra charge, you must first contact Coveo Sales to add this feature to your organization license. You can then enable it for your source.

   • Index

     When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

     • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Privilege Management and Logical Indexes Domain).

     • Once the source is added, you can’t switch to a different index.

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

   If you select the Everyone option, end users of your Coveo-powered search interface will be able to see all items to which the specified Atlassian account has access.

5. In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):

   1. In the Access Level column, select View or Edit for each available group.

   2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

   If you remove the Edit access level from all the groups of which you’re a member, you won’t 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.

6. Optionally, consider editing or adding mappings (see Adding and Managing Source Mappings).

   You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

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

     • On 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’re done editing the source and want to make changes effective.

     Back on the Sources page, you can review the progress of your Jira source addition or modification (see Adding and Managing 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 your source update schedule and optionally change it so that it better fits your needs (see Edit a Source Schedule). By default, your content is refreshed every hour and rescanned every day.