Skip to content

Jira Connector

Jira is typically used for issue tracking and agile project management, enabling teams to plan, track, and coordinate tasks through customizable workflows.

Search AI enables easy integration with Jira to ingest, index, and search through the issues, dashboards and filters. This ensures efficient search and retrieval, improving accessibility to content from JIRA.

JIRA Connector Specifications

Type of Repository Cloud
Supported Content Type Issues, Dashboards, Filters
Access Control Support Yes
Content Filtering Support Yes

Setup guide

Prerequisites

An Atlassian account with admin access. This account will be used to fetch content and find the access permissions on the indexed content.

Set up Jira​

Search AI interacts with Jira through the APIs. Hence, to set up integration, create an API token with the Atlassian account. Follow the instructions in this documentation for step-by-step instructions.

While generating the API Key, enable following scopes to allow Search AI to access relevant information from JIRA.

  • read:application-role:jira
  • read:comment:jira
  • read:comment.property:jira
  • read:dashboard:jira
  • read:filter:jira
  • read:group:jira
  • read:issue-details:jira
  • read:issue-type-hierarchy:jira
  • read:issue-type:jira
  • read:jira-work
  • read:jql:jira
  • read:project-category:jira
  • read:project-role:jira
  • read:project-version:jira
  • read:project.component:jira
  • read:project.property:jira
  • read:project:jira
  • read:user:jira

Configure Jira Connector in SearchAI

Go to the Connectors page and add the Jira Connector. Provide the following details to configure the connector.

  • Name - Provide a unique name for the connector.
  • API Token - Provide the API token generated above.
  • Domain - The URL of your Jira application instance.
  • Email - Email address for the Atlassian account set up for indexing.

Content Ingestion

Ingested content from Jira into Search AI includes three object types—Issues, Dashboards, and Filters—each with a defined set of fields. By default, the connector fetches content for the past 90 days from the application.

  • Issues

    • title: the issue’s summary or title
    • content: the full description of the issue
    • url: direct link to the issue in Jira
    • doc_created_by_name: name of the user who created the issue
    • doc_created_on: timestamp when the issue was created (UTC)
    • doc_updated_on: timestamp of the latest update to the issue (UTC)
    • doc_source_type: indicates the type of content - Issues, Dashboards or Filter.
    • priority: issue priority (High, Medium, Low, etc.)
    • status: issue status like open, close, etc
    • assignee: username of the person currently assigned
    • reporter_name: name of the user who reported the issue
    • comments: all comments on the issue concatenated into one field along with the commentator name.
    • issueType: type of issue (Bug, Task, Story)
    • resource_type: type of issue
    • project_name: name of the Jira project

  • Dashboards

    • title: the dashboard’s name
    • content: dashboard description or notes
    • URL: direct link to the dashboard in Jira
    • doc_created_by_name: name of the user who created the dashboard
    • doc_source_type: Always ‘dashboard’ for this object type.

  • Filters

    • title: the filter’s name
    • content: JQL query or filter description
    • URL: direct link to the filter in Jira
    • doc_created_by_name: name of the user who created the filter
    • doc_source_type: Always ‘filter’ for this object type.

Note:

  • All timestamps are stored in UTC.
  • The doc_source_type field distinguishes the type of Jira content.
  • Issue comments are concatenated together as comments. Individual comment metadata is not indexed.

Content Filtering

Jira Connector offers standard and advanced filters on the indexable content allowing users to choose specific set of searchable content.

Go to Manage Content page and select the Object Type that defines the types of content to be ingested. All subsequent filter settings apply only to this chosen object type(s).

Manage Content

Further you can set ingestion filters to select specific content. Select Ingest filtered content and click on Edit Configuration link.

There are two types of filters - Standard Filters and Advanced Filters.

Filters

Standard Filters

Use Standard filters to ingest selected objects from specific projects. You can select one or more projects. Once a project is selected, all items of the selected object type within that project will be ingested.

You can also define a date range for ingestion using the built-in calendar selector. This allows you to limit the data to a specific time frame based on your requirements.

Advanced Filters

Advanced Filters allow more granular control by letting you define field-based rules. For example, you can configure filters to ingest only specific types of issues from a particular project.

Advanced Filters

Choose from commonly used fields in the dropdown or enter any valid Jira field name for your instance. Note that the field name should match the field name for the selected object in your Jira instance.

Filter Precedence & Scope

  • Advanced Filters override Standard Filters whenever their criteria conflict. For instance if one project is selected in Standard Filter and an Advanced filter is set up using project key for another project, the project in advanced filter will be applied.
  • Filters affect only the selected Object Type. If an advanced filter is set up for issues whereas only dashboards are selected on Manage content page, the filter is ignored. Only results within the specified objects types are shown.

By selecting the Object Type first, then applying Standard Filters, and finally Advanced Filters, you can ensure that only the precise set of Jira content you need is ingested into Search AI.

Access Control

SearchAI supports access control for content ingested from Jira accounts in different ways.

Issues

  • In Jira, each issue is linked to a specific project through a unique Project ID.
  • This Project ID is stored in the RACL field of the chunks related to the content ingested from Jira.
  • For Search AI to determine which users can access a specific issue, use the Permission Entity APIs and associate users with the project ID.
  • Users added to the corresponding Permission Entities gain access to the issues associated with those projects.

Dashboards and Filters

When Jira dashboards or filters are shared, Search AI populates the RACL field to mirror those sharing settings. The table below describes how each sharing option maps to entries in the RACL field:

Sharing Option RACL Field Entries
Project One or more Project IDs (for each project the item is shared with)
My Organization The Organization ID
Group One or more Group IDs (for each group granted access)
Public *
User Email addresses of all individual users with access
Private Email address of the item’s owner

If multiple sharing options apply (e.g. both a Project and specific Users), all corresponding IDs and emails are included in the RACL field.