Overview
The Jira integration allows organizations to connect Jira instances to Engineering Metrics and synchronize project management data for reporting and analytics. Using this integration, organizations can:- Connect Jira Cloud environments
- Authenticate using Jira API credentials
- Synchronize Jira projects
- Configure project data scopes
- Track issue and workflow activity
- Monitor project delivery metrics
Prerequisites
Before configuring the integration, ensure you have:- Access to the Engineering Metrics Dashboard
- Access to a Jira instance
- A valid Jira API Token
- A Jira user account with appropriate permissions
- Access to the Jira projects that will be synchronized
- Required permissions to configure integrations
Navigate to Jira Connections
- Open the Engineering Metrics Dashboard.
- Navigate to Integration.
- Select Work Management Metrics.
- Choose Jira Connections.
Create a New Jira Connection
- Click New Connection.
- The Manage Connections: Jira window will appear.
Configure Connection Details
Connection Name
Enter a unique name for the Jira connection. Examples:- Jira Production
- Engineering Projects
- Delivery Management
- Jira Enterprise
Endpoint URL
Enter the Jira instance URL. Example:Username (Email)
Enter the email address associated with the Jira account. This account will be used during authentication and data synchronization.API Token
Enter a valid Jira API Token. The API Token is used to securely authenticate Engineering Metrics with Jira.The Jira account and API Token must have sufficient permissions to access the projects that will be synchronized.
Proxy
If your organization uses a proxy server, enter the proxy configuration details. This field is optional.Custom Rate Limit
Users can configure a custom API rate limit to manage Jira API consumption and synchronization behavior.Test the Connection
Before saving the connection:- Click Test Connection.
- Wait for the validation process to complete.
Expected Result
- If the configuration is valid, the connection test will succeed.
- If validation fails, verify the Endpoint URL, Username, and API Token before retrying.
Save the Connection
- After successful validation, click Save Connection.
- The Jira connection will appear in the Connections list.
Configure Data Scopes
After creating the connection:- Select the Jira connection.
- Click Add Data Scope.
Project Selection
- Search for the desired Jira project.
- Select one or more projects.
- Click Save.
Only projects included in configured data scopes will be available for synchronization and reporting.
Managing Data Scopes
Users can:- Add Data Scope
- Associate Scope Config
- Delete Data Scope
Understanding Data Scopes
A data scope represents a Jira project that has been authorized for synchronization. Only configured data scopes will be used for collecting Jira project data and generating reports.Scope Configuration
Scope configurations determine how synchronized Jira data is mapped within Engineering Metrics. These configurations help associate Jira project data with reporting and analytics dashboards.Synchronizing Jira Data
Once a Jira connection and project scope have been configured, Engineering Metrics begins collecting data from the selected Jira projects. Collected information may include:- Issues and tickets
- Project activity
- Workflow progress
- Sprint information
- Project delivery metrics
- Work item status changes
Monitoring Synchronization Activity
Engineering Metrics provides visibility into synchronized Jira data through dashboards and reporting features. Users can review:- Project activity
- Issue trends
- Delivery metrics
- Workflow performance
- Work management insights
Troubleshooting
Connection Test Failed
Possible causes:- Invalid Jira URL
- Invalid API Token
- Incorrect username
- Network connectivity issues
- Verify the Jira URL
- Confirm the API Token is valid
- Verify the username entered
- Retry the connection test
Projects Not Appearing
Possible causes:- Insufficient Jira permissions
- Project access restrictions
- Synchronization delay
- Verify project permissions
- Confirm project visibility
- Retry synchronization
Synchronization Issues
Possible causes:- API rate limiting
- Authentication failures
- Missing project permissions
- Verify authentication credentials
- Confirm project access permissions
- Review synchronization status and retry
Best Practices
- Use dedicated Jira service accounts where possible
- Use descriptive connection names
- Regularly validate API tokens
- Synchronize only required projects
- Monitor synchronization activity regularly
- Periodically review project scope configurations

