Overview

SearchBlox provides a Jira Collection to index issues, projects, and related content stored in Jira. It connects directly to your Jira instance, automatically crawls the issues and projects, and indexes their content for search — making Jira data easily searchable without manual uploads.

Note: Jira Collection supports RAG for AI-powered search, Knowledge Graph for entity extraction, private access control, content encryption, and configurable language settings.

Prerequisites for Jira Collection

Before creating a Jira Collection in SearchBlox, ensure the following are in place:

• Atlassian account — A valid Atlassian account with access to the Jira instance to be indexed. The account email will be used as the username.
• Jira domain URL — The base domain of your Jira instance, starting with http:// or https:// (e.g., https://your-domain.atlassian.net).
• API Token — A unique API token generated from your Atlassian account dashboard, used to authenticate the connection.
• Read access to target projects — The Atlassian account must have permission to browse and view issues in the project(s) to be indexed.
• Network/firewall access — Port and firewall rules must allow SearchBlox to reach the Jira domain.

Creating a Jira Collection

• Log in to the Admin Console.
• Navigate to the Collections tab.
• Click the Create button or the + icon.
• Select Jira Collection as the collection type.
• Enter a Collection Name. The name must be unique and contain 3–36 alphanumeric characters. Only underscores (_) are allowed as special characters.
• Configure Enable RAG by turning it ON to allow the collection to be used for Retrieval Augmented Generation, or turn it OFF if AI-based retrieval is not required.
• Configure Enable Knowledge Graph by turning it ON to extract entities and relationships from documents, or turn it OFF if this feature is not needed.
• Configure Private Collection Access by enabling it to restrict access to authenticated users only, or disabling it to allow public (unauthenticated) access.
• Configure Collection Encryption if required to protect document content or metadata fields. Metadata fields can be encrypted using the deid_ prefix.
• Select the Collection Language based on the primary language used in the issue content. The default language is English.
• Click Create to create the Jira Collection.

Once the collection is created, you will be taken to the Settings tab to configure the connection details for crawling your Jira instance.

Configuring Jira Settings

To configure the connection for your Jira Collection, follow these steps:

Authentication

1. Go to the Settings tab within the collection.

2. Enter the User name.
   The username will be your Atlassian account email. Must be a valid email address (e.g., [email protected]).

3. Enter the Domain.
   Specify your Jira domain name. The URL should start with http:// or https:// (e.g., https://your-domain.atlassian.net).

4. Enter the API Token.
   The API Token is a unique token that can be generated from your Atlassian account dashboard.

Generate Using LLM

• Enable Title to automatically generate concise and relevant titles for the documents using LLM while indexing.
• Enable Description to generate relevant descriptions for the documents using LLM while indexing.
• Enable Topics to generate relevant topics for the documents using LLM while indexing.

Relevance

• Auto Relevance — Enable to use Hybrid Search for automatic relevance ranking.

5. Click Test Connection to verify that SearchBlox can successfully authenticate and connect to your Jira instance.

6. Click Save to store the configuration, or Cancel to discard changes.

Projects Tab

Using the Projects tab, you can select which Jira projects should be crawled and indexed by the collection.

• Use the Search Projects field to search for a specific Jira project by name or key, and click the search icon to filter the list.
• Projects retrieved from your Jira instance (based on the authenticated account's access) are listed for selection.
• Select one or more projects to scope the collection to only crawl issues from those projects. If no projects are selected, the collection may crawl all accessible projects, depending on configuration.
• Click Clear All to remove all selected projects.
• Click Save to store the selected project configuration, or Cancel to discard changes.

Note: If no projects are returned in the list, verify that the connection was tested and saved successfully in the Settings tab, and that the authenticated account has access to at least one Jira project.

Synonyms

Synonyms help the search show relevant documents even when the exact search word is not used.
For example, if someone searches for “global,” the results can also include documents that use “world” or “international.”
We have an option to load Synonyms from the existing documents.

Stopwords

Stopwords are common, high-frequency words that carry minimal semantic value and are typically excluded during text processing, indexing, or search operations. Examples include articles (a, an, the), conjunctions (and, but, or), prepositions (in, on, about), and auxiliary verbs (is, was, would, had).

Purpose:

Reduce noise in search indexing and text analysis
Improve processing efficiency by excluding low-value tokens
Enhance search relevance by prioritizing meaningful keywords

Schedule and Index

Sets the frequency and the start date/time for indexing a collection. Schedule Frequency supported in SearchBlox is as follows:

• Once
• Hourly
• Daily
• Every 48 Hours
• Every 96 Hours
• Weekly
• Monthly

The following operation can be performed in Azure blob collections

Manage Documents Tab

• Using Manage Documents tab we can do the following operations:

  1. Filter
  2. View content
  3. View metadata
  4. Refresh
  5. Delete

• To delete a file from your collection, enter the file path and click "Delete".

• To see the status of an indexed file, click "View Metadata".

Data Fields Tab

Using the Data Fields tab, you can create custom fields for search and view the default and configured fields for the collection.

• Toggle Show Defaults ON to display the collection's default system fields, in addition to any custom fields.
• Use the + icon to add a new custom Data Field.
• Use the info icon to view details about field configuration.
• Use the refresh icon to reload the fields list.

Each field is listed with the following columns:

SearchBlox supports the following Data Field types:

Note: Once Data Fields are configured, the collection must be cleared and re-indexed for the changes to take effect.

Prompts

• When LLM/RAG is enabled, you can edit AI-based prompts for Title, Description, Topic, Image Description, and Smart FAQs.
• You can customize these prompts anytime, and use Restore Default to reset them back to the original SearchBlox settings.

Models

The Models section lets you override the global embedding, reranking, and LLM settings for this specific collection. Changes made here apply only to the current collection and do not affect other collections.

Embedding

• Provider specifies the embedding provider used to generate vector representations of documents
• Model defines the embedding model used to convert document content into vectors for semantic search

Reranker

• Provider specifies the reranker provider used for improving search result relevance
• Model defines the reranker model used to re-score and reorder search results based on relevance

LLM

• Provider specifies the Large Language Model provider used for AI-powered features
• Model defines the LLM used for tasks such as document enrichment, summaries, and SmartFAQs

Knowledge Graph

• Enable Knowledge Graph — Turn ON to extract entities and relationships from this collection into a Knowledge Graph. This setting applies at the next index — re-index the collection to build or rebuild the graph.

Once enabled, the Knowledge Graph tab provides the following views, accessible from the side navigation:

Overview

Displays a summary of the current Knowledge Graph status for the collection:

• Status — Indicates whether the Knowledge Graph is Active or inactive for this collection.
• Entities — The total number of entities extracted from the collection's documents.
• Relationships — The total number of relationships identified between entities.
• Contexts — The total number of contexts captured during extraction.

Use the icons in the top-right of the Overview panel to refresh the graph data, rebuild the graph, or clear existing graph data.

Topics

Displays the high-level topics extracted from this collection's documents. If no topics have been generated yet (for example, before the first index/re-index), this section shows No topics found for this collection.

Relationships

Displays the predicates connecting entities within this collection's Knowledge Graph — i.e., how extracted entities relate to one another. If no relationships have been identified yet, this section shows No relationships found for this collection.

Entities

Displays the entities extracted from this collection's documents. Click an entity name to view its details and mentions across the indexed content.

Note: Knowledge Graph data (Topics, Relationships, and Entities) is populated only after the collection has been indexed or re-indexed with Knowledge Graph enabled.

Permission Webhook

The Permission Webhook allows Jira to notify SearchBlox in real time when document-level permissions change, keeping secure search access in sync without waiting for the next scheduled index.

• Jira Webhook URL — A unique, auto-generated URL for this collection (identified by its collection ID).

  • If the webhook has not yet been set up, this field appears blank.
  • Once generated, this field displays a URL in the format:
    https://<server>/rest/v2/api/permission-sync/webhook/jira?collectionId=<id>
  • Register this URL in Jira to push permission changes for this collection.
  • Click the copy icon to copy the URL to your clipboard.

• Webhook Secret — A secret used to authenticate and validate incoming webhook requests from Jira.

  • If no secret has been configured yet, the field displays No secret configured.
  • Click Generate Secret to create a new webhook secret. Once generated, copy and paste it into the corresponding webhook configuration on the Jira (source system) side.

• Click How to configure for step-by-step guidance on registering the webhook URL and secret in Jira.

Note: The Webhook URL and Secret must both be configured in Jira's webhook settings for permission changes (e.g., issue security or permission scheme updates) to sync automatically with this collection.