Add or edit a Jira Software Server source
Add or edit a Jira Software Server source
When you have the required privileges, you can add the content of a Jira Software (Server) instance to a Coveo organization.
|
Leading practice
The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions. |
Source key characteristics
| Features | Supported | Additional information | |
|---|---|---|---|
Jira Software version |
8 |
Only the minor versions currently maintained by Atlassian are supported. The latest version to have been tested with Coveo is 8.15. |
|
Searchable content types |
|
Projects[1], issues, comments, attachments, and work logs |
|
|
A rescan or rebuild is required to retrieve:
|
||
|
|||
|
|||
Content security options |
|
Requires the Coveo plugin to index all permission types. |
|
|
|||
|
|||
Requirements
Supported Jira Software versions
Atlassian Jira Software 8 is supported.
Jira Software Data Center is supported.
Atlassian Jira Software server accessible to Coveo
When the access to communication ports between Coveo 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 to access the content.
|
Note
Single sign-on (SSO) isn’t supported. If your instance uses an SSO, you must create a native Atlassian crawling account directly in Jira to bypass it and crawl the instance content. |
Crawling account permissions
When you want to retrieve the content of your Jira Software instance, a crawling account 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 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 or edit a Jira Software Server source
When adding a source, in the Add a source of content panel, click the On-Premises (
) or the Crawling Module (
) tab, depending on whether you need to use the Coveo On-Premises Crawling Module to retrieve your content. See Content Retrieval Methods for details.
To edit a source, on the Sources (platform-ca | platform-eu | platform-au) page, click the desired source, and then click Edit in the Action bar.
A Jira Software Server source indexes on-premises (server) content. To retrieve cloud content instead, see Add or edit a Jira Software Cloud source.
"Configuration" tab
In the Add/Edit a Jira Software Server Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.
Content security requirements
Download and install the Coveo Jira plugin on your Jira Software server if you intend to select the Same users and groups as in your content system content security option. Without the plugin, only some permission types are indexed.
General information
Source name
Enter a name for your source.
|
|
Leading practice
A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens ( |
Instance URL
Enter the base URL of the Jira Software Server instance that you want to index.
http://MyJiraServer:8080/
Paired crawling module
If your source is a Crawling Module source, and if you have more than one Crawling Module linked to this organization, select the one with which you want to pair your source. If you change the Crawling Module instance paired with your source, a successful rebuild is required for your change to apply.
Optical Character Recognition (OCR)
If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.
|
|
Note
Contact Coveo Sales to add this feature to your organization license. |
"Authentication" section
Enter one of the following:
-
The credentials of a dedicated Jira Software account that has access to the content that you want to index.
-
A personal access token corresponding to this account. However, to use this option, you must have the secure administrator session feature deactivated.
See Source credentials leading practices for details.
This account must also have the Jira Administrators global permission.
"Content to Include" section
Some types of data are optional to index. Select the desired content.
Attachments
Check this box to index binary files attached to an issue.
Comments
Check this box to index comments posted on issues. The comments will be indexed as metadata of the Jira Software issue under which they appear.
Check the Comment permissions box to index comments as individual items rather than as metadata of an issue item. The access permissions will also be indexed, which means that only the users allowed to access a comment will be able to find it through a Coveo-powered search interface.
Work logs
Check this box to index time entries on issues.
"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.
|
|
Note
The Same users and groups as in your content system option requires you to provide the credentials of a Jira Administrator account in the Configuration tab, under Authentication. |
"Access" tab
In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):
-
If available, in the left pane, click Groups or API Keys to select the appropriate list.
-
In the Access Level column for groups or API keys with access to source content, select View or Edit.
Completion
-
Finish adding or editing your source:
-
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, click Add Source/Save.
NoteOn the Sources (platform-ca | platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.
-
When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.
Back on the Sources (platform-ca | platform-eu | platform-au) page, you can review the progress of your source addition or modification.
Once the source is built or rebuilt, you can review its content in the Content Browser.
-
-
Optionally, consider editing or adding mappings once your source is done building or rebuilding.
Should you need to create mapping rules for Jira Software custom fields, see this article.
|
|
Leading practice
By default, a Jira Software 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 Add Source Filters for further information. |
Permission types indexed without the Coveo Plugin
If you select the Same users and groups as in your content system content security option, you should install the Coveo Jira plugin on your Jira Software server. Without it, only the following permission types are supported:
| Jira Software permission types | Supported without plugin |
|---|---|
Group & user |
|
Project |
|
Application role |
|
Issue-level |
|
Attachments |
|
Comments |
|
Time Tracking |
|
What’s next?
-
If you’re using the Crawling Module to retrieve your content, consider subscribing to deactivation notifications to receive an alert when a Crawling Module component becomes obsolete and stops the content crawling process.
Very useful
Not really
Very useful
Not really