Add or Edit a Source
- Amazon S3 Source
- Box (Personal) Source
- Box Business Source
- Confluence Cloud Source
- Confluence Self-Hosted Source
- Database Source
- Dropbox (Personal) Source
- Dropbox Business Source
- Exchange Enterprise Source
- Exchange Online (Personal) Source
- File System Source
- Generic REST API Source
- Gmail for Work Source
- Gmail (Personal) Source
- Google Drive (Personal) Source
- Google Drive for Work Source
- Jira Software Cloud Source
- Jira Software Self-Hosted Source
- Jive Cloud Source
- Jive Server Source
- Lithium Source
- Microsoft Dynamics 365 Source
- OneDrive for Business Source
- OTCS Source
- Push Source
- RSS Source
- Salesforce Source
- ServiceNow Source
- SharePoint Online Source
- SharePoint Online Legacy Source
- SharePoint Server Source
- Sitecore Source
- Sitemap Source
- Twitter Source
- Web Source
- YouTube Source
- Zendesk Source
Add or Edit a Jira Software Self-Hosted Source
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 they have access in Jira Software. However, the Coveo Jira Plugin for self-hosted Jira Software is still needed to fully support all permission types in Jira Software 7 and 8.
|Supported Jira Software permission types without plugin||Jira Software 7 and 8|
|Group & user|
Note 1: You must activate the option on the source to support permissions on comments (see Comment Permissions).
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).
Source Features Summary
|Jira Software version||7 to 8|
|Searchable content types||
Projects1, issues, comments, attachments, and work logs
Rescan or rebuild needed to retrieve:
|Content security options||Secured||
Requires the Coveo plugin.
Note 1: Project metadata is included on the issues of the project, but the projects themselves are not included.
Supported Jira Software Versions
- Jira Software Data Center is supported.
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.
Add or Edit a Jira Software Self-Hosted Source
Ensure your Jira Software instance meets the source requirements (see Requirements).
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.
To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.
In the Configuration tab:
Under Supported Versions, check if your version of Jira Software is supported.
Under Content Update and Security Requirements:
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).
Enter appropriate values for the available parameters:
A descriptive name for your source under 255 characters (not already in use for another source in this organization).
The base URL of the Jira Software instance that you want to include the content.
Character optical recognition (OCR)
Check this box if you want Coveo Cloud to extract text from image files and/or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it is fully searchable and will appear in the item Quick View (see Search Result Quick View).
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 Multiple Coveo Indexes). If your organization only has one index, this drop-down menu is not visible and you have no decision to make.
Select who can see items from this source in a search interface that includes this source in its scope (see Content Security). Your options are:
Shared: Everyone will be able to find the source content in the search interface.
Private: Only the source creator will be able to find the source content in the search interface. They must however authenticate to the search interface with the identity with which they created the source.
Secured: Only users authenticated in the search interface will see the source items for which they have read permission.
In the Authentication section, provide authentication information:
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.
Type in the corresponding password.
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 site is crawled. Deselect 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)
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)
- In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):
- 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.
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.
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).
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 Self-Hosted 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).
Click Add and Build Source/Save and Rebuild Source when you are done editing the source and want to make changes effective.
Once the source is built or rebuilt, you can review its content in the Content Browser (see Inspect Items With the Content Browser).
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 15 minutes.