--- title: Add a Jira Software Cloud source slug: '1655' canonical_url: https://docs.coveo.com/en/1655/ collection: index-content source_format: adoc --- # Add a Jira Software Cloud source When you have the required privileges, you can add the content of a Jira Software Cloud instance to a [Coveo organization](https://docs.coveo.com/en/185/). > **Leading practice** > > The number of [items](https://docs.coveo.com/en/210/) that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. > See [About crawling speed](https://docs.coveo.com/en/2078/) for information on what can impact crawling speed, as well as possible solutions. ## Source key characteristics The following table presents the main characteristics of a Jira Software Cloud source. [%header,cols="~,~,~,~"] |=== 2+|Features ^|Supported |Additional information 2+|Jira Software Cloud version ^|Latest cloud version | 2+|Indexable content ^|Jira projects (Jira project metadata is included on the issues of the project, but the projects themselves aren't included.), issues, comments, attachments, and work logs | .3+|[Content update operations](https://docs.coveo.com/en/2039/) |[refresh](https://docs.coveo.com/en/2710/) ^|[check] a|[Takes place every hour by default.](https://docs.coveo.com/en/1933/) 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](https://docs.coveo.com/en/2711/) ^|[check] |[Takes place every day by default.](https://docs.coveo.com/en/1933/) |[rebuild](https://docs.coveo.com/en/2712/) ^|[check] | .3+|[Content security](https://docs.coveo.com/en/1779/) options |[Same users and groups as in your content system](https://docs.coveo.com/en/1779#same-users-and-groups-as-in-your-content-system) ^|[check] |Requires installing the [Coveo User Sync app](https://marketplace.atlassian.com/search?query=Coveo%20User%20Sync%20app) in your instance. See [About the Coveo User Sync App](#about-the-coveo-user-sync-app) for details. |[Specific users and groups](https://docs.coveo.com/en/1779#specific-users-and-groups) ^|[check] | |[Everyone](https://docs.coveo.com/en/1779#everyone) ^|[check] | .3+|[Metadata indexing for search](#index-metadata) |Automatic mapping of [metadata](https://docs.coveo.com/en/218/) to [fields](https://docs.coveo.com/en/200/) that have the same name 2+a|This setting is disabled by default and [not recommended for this source type](https://docs.coveo.com/en/1640#about-the-performfieldmappingusingallorigins-setting). |Automatically indexed [metadata](https://docs.coveo.com/en/218/) 2+a|Examples of [auto-populated default fields](https://docs.coveo.com/en/1833#field-origin) (no user-defined metadata required):   * `clickableuri` * `jifieldsassigneedisplayname` * `jifieldscreated` * `jifieldspriorityname` * `jifieldsstatusname` * `title`   After a content update, [inspect your item field values](https://docs.coveo.com/en/2053#inspect-search-results) in the **Content Browser**. |Extracted but not indexed metadata 2+a|The Jira Software Cloud source extracts some of the metadata that the Jira API makes available, such as project-related metadata on issues. The source extracts Jira issue standard fields as metadata named `fields.` and custom fields as metadata named `fields.customfield_`, where `` is the numeric identifier of the Jira custom field.   After a rebuild, review the [**View and map metadata**](https://docs.coveo.com/en/m9ti0339#view-and-map-metadata-subpage) subpage for the list of indexed metadata, and [index additional metadata](https://docs.coveo.com/en/m9ti0339#index-metadata). |=== > **Note** > > Issues in a private Jira project are indexed if the [crawling account](https://docs.coveo.com/en/2122/) 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](https://docs.coveo.com/en/2122/) 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](https://confluence.atlassian.com/adminjiraserver071/managing-global-permissions-802592439.html) 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](https://docs.coveo.com/en/204/) cloud content. To retrieve on-premises (server) content, see [Add a Jira Software Data Center source](https://docs.coveo.com/en/1772/) instead. > **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](https://docs.coveo.com/en/3239/) or manually. > > See [About non-production organizations](https://docs.coveo.com/en/2959/) for more information and best practices regarding sandbox organizations. . On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click **Add source**. . In the **Add a source of content** panel, click the **Jira Software Cloud** (icon:cloud-icon[alt=cloud-icon,width=16]) source tile. . 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 root URL of your Jira instance. It often ends with `jira.com`. ** **Authentication**: How Coveo should log in to your Jira Software project to index your content. **If you select **Atlassian account****
Details .. 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](https://docs.coveo.com/en/1920/) for other leading practices to follow. .. With this account, [create an API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/?_ga=2.126505613.1817776130.1555381268-505570362.1555381268). This token should also be dedicated to your source. [NOTE] **Note**
[Tokens with scopes](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token-with-scopes) aren't supported. ##### .. Provide Coveo with the email address and API token corresponding to the source's Atlassian account. .. Install the [Coveo User Sync app](#about-the-coveo-user-sync-app) in your Jira Software project to synchronize users and groups with Coveo. .. Click **Add source**. #### **If you select **No login****
Details .. Click **Next**. .. Select who will be able to access the source items through a Coveo-powered [search interface](https://docs.coveo.com/en/2741/). For details on this parameter, see [Content security](https://docs.coveo.com/en/1779/). .. Click **Add source**.
** **Project**: Use the **Project** selector to associate your source with one or more Coveo [projects](https://docs.coveo.com/en/n7ef0517/). > **Note** > > After source creation, you can update your Coveo project selection under the [**Identification**](#identification-subtab) subtab. ### "Configuration" tab When configuring or editing your Jira Software 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](https://docs.coveo.com/en/218/) of this content. Moreover, you can index work logs from time entries on indexed issues. #### "Authentication" subtab ** **Jira address**: The root URL of your Jira instance. It often ends with `jira.com`. ** **Authentication**: How Coveo should log in to your Jira Software project to index your content. **If you select **Atlassian account****
Details .. 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](https://docs.coveo.com/en/1920/) for other leading practices to follow. .. With this account, [create an API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/?_ga=2.126505613.1817776130.1555381268-505570362.1555381268). This token should also be dedicated to your source. [NOTE] **Note**
[Tokens with scopes](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token-with-scopes) aren't supported. ##### .. Provide Coveo with the email address and API token corresponding to the source's Atlassian account. .. Install the [Coveo User Sync app](#about-the-coveo-user-sync-app) in your Jira Software project to synchronize users and groups with Coveo. .. Click **Add source**. #### **If you select **No login****
Details .. Click **Next**. .. Select who will be able to access the source items through a Coveo-powered [search interface](https://docs.coveo.com/en/2741/). For details on this parameter, see [Content security](https://docs.coveo.com/en/1779/). .. Click **Add source**.
The **Authentication** subtab contains settings used by the source crawler to emulate the behavior of a user authenticating to access restricted Jira Software content. **Jira address**: The root URL of your Jira instance. It often ends with `jira.com`. **Authentication**: How Coveo should log in to your Jira Software project to index your content. **If you select **Atlassian account****
Details . 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](https://docs.coveo.com/en/1920/) for other leading practices to follow. . With this account, [create an API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/?_ga=2.126505613.1817776130.1555381268-505570362.1555381268). This token should also be dedicated to your source. [NOTE] **Note**
[Tokens with scopes](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token-with-scopes) aren't supported. ##### . Provide Coveo with the email address and API token corresponding to the source's Atlassian account. . Install the [Coveo User Sync app](#about-the-coveo-user-sync-app) in your Jira Software project to synchronize users and groups with Coveo. #### .If you select **No login**
Details Go to the **Content security** tab, and then select who will be able to access the source items through a Coveo-powered [search interface](https://docs.coveo.com/en/2741/). For details on this parameter, see [Content security](https://docs.coveo.com/en/1779/).
#### "Identification" subtab The **Identification** subtab contains general information about the source. ## Name The source name. It can't be modified once it's saved. :leveloffset!: ##### Project Use the **Project** selector to associate your source with one or more Coveo [projects](https://docs.coveo.com/en/n7ef0517/). ### "Items" tab On the **Items** tab, you can specify how the source handles items based on their file type or content type. #### File types File types let you define how the source handles [items](https://docs.coveo.com/en/210/) based on their file extension or content type. For each file type, you can specify whether to index the item content and [metadata](https://docs.coveo.com/en/218/), only the item metadata, or neither. You should fine-tune the file type configurations with the objective of indexing only the content that's relevant to your users. **Example** Your repository contains `.pdf` files, but you don't want them to appear in search results. You click **Extensions** and then, for the `.pdf` extension, you change the **Default action** and **Action on error** values to `Ignore item`. For more details about this feature, see [File type handling](https://docs.coveo.com/en/l3qg9275/). #### 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](https://docs.coveo.com/en/2760#search-result-quick-view). > **Note** > > When OCR is enabled, ensure the source's relevant [file type configurations](https://docs.coveo.com/en/l3qg9275/) index the item content. > Indexing the item's metadata only or ignoring the item will prevent OCR from being applied. See [Enable optical character recognition](https://docs.coveo.com/en/2937/) for details on this feature. ### "Content security" tab Select who will be able to access the source items through a Coveo-powered [search interface](https://docs.coveo.com/en/2741/). For details on the content security options, see [Content security](https://docs.coveo.com/en/1779/). > **Notes** > > * The **Same users and groups as in your content system** option requires you to install the [Coveo User Sync app](https://marketplace.atlassian.com/search?query=Coveo%20User%20Sync%20app) in your instance. > Install the version of the app that corresponds to the [region](https://docs.coveo.com/en/2976/) of your Coveo organization, or install the [HIPAA](https://docs.coveo.com/en/1853/) version for Coveo HIPAA environments. > See [About the Coveo User Sync App](#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 on the **Configuration** tab, under **Authentication**. ### "Access" tab . On the **Access** tab, specify whether each group (and API key, if applicable) in your [Coveo organization](https://docs.coveo.com/en/185/) 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. For more information, see [Custom access level](https://docs.coveo.com/en/3151#custom-access-level). On the **Access** tab, specify whether each group (and API key, if applicable) in your [Coveo organization](https://docs.coveo.com/en/185/) 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. For more information, see [Custom access level](https://docs.coveo.com/en/3151#custom-access-level). ### Build the source . Finish adding or editing your source: ** When you're done editing the source and want to make your changes effective, click **Add and build source**/**Save and rebuild source**. ** When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to make other changes soon, click **Add source**/**Save**. On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click **Launch build** or **Start required rebuild** when you're ready to make your changes effective and index your content. > **Leading practice** > > By default, a Jira Software source indexes the entire Jira Software instance content. > To index only certain projects, click **Save**, and then specify the desired address patterns in your [source JSON configuration](https://docs.coveo.com/en/1685/) before launching the initial build. > See [Add source filters](https://docs.coveo.com/en/2006#add-source-filters) for further information. ### Index metadata To use [metadata](https://docs.coveo.com/en/218/) values in [search interface](https://docs.coveo.com/en/2741/) [facets](https://docs.coveo.com/en/198/) or result templates, the metadata must be [mapped](https://docs.coveo.com/en/217/) to [fields](https://docs.coveo.com/en/200/). Coveo automatically [maps](https://docs.coveo.com/en/217/) only a subset of the metadata it extracts. You must map any additional metadata to fields manually. > **Note** > > Not clear on the purpose of indexing metadata? > Watch [this video](https://www.youtube.com/watch?v=BmmmVJ3AWi0). . On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click your source, and then click **More** > **View and map metadata** in the Action bar. . Review the default [metadata](https://docs.coveo.com/en/218/) that your source is extracting from your content. . Map any currently _not indexed_ metadata that you want to use in facets or result templates to fields. The source extracts Jira custom fields as metadata named `fields.customfield_`, where `` is the numeric identifier of the Jira custom field. For help associating Jira custom field names with their numeric identifiers, see [this article](https://docs.coveo.com/en/3452/). .. Click the metadata and then, at the top right, click **Add to Index**. .. 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](https://docs.coveo.com/en/1833#add-a-field) if none of the existing fields are appropriate. > **Note** > > For advanced mapping configurations, like applying a mapping to a specific item type, see [Manage mappings](https://docs.coveo.com/en/1640#manage-mappings). .. Click **Apply mapping**. . Return to the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page. . To reindex your source with your new mappings, click your source, and then click **More** > **Rebuild** in the Action bar. . Once the source is rebuilt, review your item field values. They should now include the values of the metadata you selected to index. .. On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click your source, and then click **More** > **Open in Content Browser** in the Action bar. .. Select the card of the item for which you want to inspect properties, and then click **Properties** in the Action bar. .. In the panel that appears, select the **Fields** tab. ## 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](https://confluence.atlassian.com/cloud/maintenance-windows-744721660.html). If possible, [schedule](https://docs.coveo.com/en/1933/) 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](https://docs.coveo.com/en/1779/). 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](#content-security-tab) from **Everyone** to **Same users and groups as in your content system**, you'll need to [refresh the security identity provider](https://docs.coveo.com/en/1905#refresh-all-security-identities) after installing the app. For more information on [sources that index permissions](https://docs.coveo.com/en/1779#same-users-and-groups-as-in-your-content-system) and on how Coveo handles these permissions, see [Coveo management of security identities and item permissions](https://docs.coveo.com/en/1719/). ## Required privileges You can assign privileges to allow access to specific tools in the [Coveo Administration Console](https://docs.coveo.com/en/183/). The following table indicates the privileges required to view or edit elements of the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page and associated panels. See [Manage privileges](https://docs.coveo.com/en/3151/) and [Privilege reference](https://docs.coveo.com/en/1707/) for more information. > **Note** > > The **Edit all** privilege isn't required to create sources. > When granting privileges for the [Sources](https://docs.coveo.com/en/1707#sources-domain) domain, you can grant a group or API key the **View all** or [**Custom**](https://docs.coveo.com/en/3151#custom-access-level) access level, instead of **Edit all**, and then select the **Can Create** checkbox to allow users to create sources. > See [Can Create ability dependence](https://docs.coveo.com/en/3151#can-create-ability-dependence) for more information. ## What's next? * [Schedule source updates](https://docs.coveo.com/en/1933/). [Schedule source updates](https://docs.coveo.com/en/1933/).