JIRA Connector

Overview

The Jira Connector is a powerful tool designed to streamline your project management workflow by seamlessly integrating with your Jira instance. It allows users to effortlessly retrieve comprehensive issue data from their specified projects. The connector will fetch all associated issues, including key details like description, summary, status, assignee, comments, and more. This connector is ideal for users who need quick access to detailed Jira project information, enabling informed decision-making and efficient project tracking through our products ACE Search and Chat.

Table of Contents

• JIRA Connector
  • Overview
  • Table of Contents
  • Required Inputs
    • 1. Server URL
    • 2. Username
    • 3. API Token
      • For Jira Cloud:
      • For Self-hosted Jira:
    • 4. Project Key
  • Example Configuration
  • Supported Entities
  • Advanced Configuration
    • Filtering Issues
    • Setting Up Recurring Updates
  • Security Considerations
  • Troubleshooting
  • Best Practices
  • FAQ

Required Inputs

1. Server URL

The server URL is the base URL of your Jira instance.

• Jira Cloud: It typically looks like https://your-domain.atlassian.net
• Self-hosted Jira: It will be the URL of your Jira server

2. Username

Your username is usually your email address that you use to log in to Jira.

3. API Token

For Jira Cloud:

1. Go to the Atlassian API Token page
2. Click on Create API token
3. Give the token a label and click Create
4. Copy the generated token

For Self-hosted Jira:

You might need to use your password or a token generated by your administrator, depending on your Jira server's authentication settings.

4. Project Key

The project key is a unique identifier for your Jira project. You can find it in the following ways:

• When viewing a project in Jira, the project key is displayed in the project details
• It's also visible in the URL when you're viewing the project in your browser. For example, in https://your-domain.atlassian.net/jira/software/c/projects/PROJECTKEY/boards/1, PROJECTKEY is your project key

Example Configuration

• Server URL: https://your-domain.atlassian.net
• Username: your-email@example.com
• API Token: Generated from the Atlassian API token page
• Project Key: PROJECTKEY (visible in the project details or URL in Jira)

Supported Entities

The Jira Connector extracts and makes available the following issue data:

• Issue Description
• Issue Key
• Issue Summary
• Issue Status
• Issue Assignee
• Issue Reporter
• Issue Created at
• Issue Updated at
• Project name
• Issue Comments
• Issue Labels
• Worklogs
• Components
• Versions
• Sprints

Advanced Configuration

Filtering Issues

You can configure the connector to retrieve only specific issues by using Jira Query Language (JQL). For example:

• To retrieve only open issues: status = "Open"
• To retrieve issues assigned to a specific user: assignee = "username@example.com"
• To retrieve issues updated in the last week: updated >= -7d

To apply these filters:

1. In the connector configuration, locate the "JQL Query" field
2. Enter your JQL query
3. Save the configuration

Setting Up Recurring Updates

To keep your Jira data current:

1. Enable the "Recurring" option in the connector settings
2. Choose the frequency:
   • Hourly: For projects with frequent updates
   • Daily: For most project types
   • Weekly: For slower-moving projects
3. Set the specific interval (e.g., every 6 hours, every 2 days)
4. Save the configuration

Security Considerations

When configuring the Jira Connector, consider the following security best practices:

• API Token Security: Store your API token securely and never share it
• Limit Access: Only grant the connector access to the specific projects needed
• Regular Rotation: Periodically rotate your API tokens to maintain security
• Audit Usage: Regularly review who has access to the connector and its data

Troubleshooting

Issue	Solution
Authentication Failed	Verify your username and API token are correct and that the API token hasn't expired
No Issues Retrieved	Check that the Project Key is correct and that there are issues in the project
Connection Timeout	Ensure your Jira instance is accessible and not experiencing downtime
Permission Denied	Verify you have sufficient permissions to access the project in Jira
Incomplete Data	Check that your API token has the necessary permissions to read all issue data

Best Practices

• Start Small: Begin by connecting to a single, small project to test the connector
• Use Specific Project Keys: Avoid using wildcards or multiple project keys until you're familiar with the connector
• Monitor Performance: If you have large projects, consider using JQL to limit the number of issues retrieved
• Regular Updates: Set up recurring updates at appropriate intervals based on your project activity
• Data Validation: After initial setup, verify that all expected issues and their data are properly retrieved

FAQ

Q: Can I connect to multiple Jira projects?
A: Yes, you can create separate connector configurations for each project.

Q: Does the connector retrieve attachments?
A: No, the connector currently retrieves issue metadata and text content only.

Q: How often is the data updated?
A: Data is updated according to your recurring settings, or you can manually trigger an update.

Q: Can I use the connector with Jira Server and Jira Cloud?
A: Yes, the connector works with both Jira Cloud and self-hosted Jira Server instances.

Q: Is there a limit to how many issues can be retrieved?
A: While there's no hard limit, performance may be impacted with very large projects (10,000+ issues).