๐Ÿ› ๏ธ Administratorโ€™s Guide

๐Ÿ› ๏ธ Administratorโ€™s Guide

This guide is for Jira Cloud administrators responsible for managing and configuring the Sprint Health Analyzer app.

The app runs in the context of a Jira project and uses changelogs, sprints, statuses, and story point fields to generate visual reports about delivery risk and Agile progress. No additional configuration is required โ€” but some setup steps can improve accuracy.


โœ… Installation

  1. Go to Atlassian Marketplace and search for Sprint Health Analyzer.

  2. Click Get app and install it to your Jira Cloud instance.

  3. Grant project-level access to users or groups who need to use the app.


๐Ÿงพ Required Permissions

Feature

Required Permission

Feature

Required Permission

Load sprint issues

Browse Projects

Read issue fields and links

View Issues

Access changelog history

View Development Tools

Export data (CSV, JSON, etc.)

No additional required

๐Ÿ”’ The app does not write to issues or modify any data in Jira.


๐Ÿ“ฆ Data Used by the App

The following fields and resources are used internally:

Source

Purpose

Source

Purpose

status

Used to calculate cycle time and pattern

changelog

For detecting status jumps and time in status

issuelinks

For dependency and blocking analysis

storyPoints

Required for velocity/burndown/burnup

sprint

Used to determine scope and velocity

resolutiondate

Used as fallback for issue closure time


โš™๏ธ Recommended Setup for Best Accuracy

Recommendation

Why It Matters

Recommendation

Why It Matters

Use standard naming for statuses

Needed for blocked/done state detection

Ensure Story Points field is present

Required for Agile metrics

Avoid changing issue statuses manually

Can distort cycle time and jump count

Limit sprint scope changes mid-sprint

Affects burndown and burnup reliability


๐Ÿ“ Supported Environments

Feature

Supported

Feature

Supported

Jira Cloud (UI Kit)

โœ… Fully supported

Jira Data Center

โŒ Not supported

Team-managed projects

โœ… Supported

Company-managed projects

โœ… Supported

Classic workflows

โœ… Supported

Next-gen workflows

โœ… Supported


๐Ÿ” Troubleshooting

Issue

Suggested Fix

Issue

Suggested Fix

โ€œNo data availableโ€ on load

Ensure sprint exists and issues are assigned

Health Score = 0 for all issues

Missing changelog access or invalid status names

No velocity/burndown shown

Story Points missing or unassigned sprint

App doesnโ€™t load

Refresh page or re-authenticate if session expired


๐Ÿ“ค Data Storage & Privacy

  • All data is fetched from your Jira instance via Forge.

  • No data is sent to external servers.

  • Metrics are calculated client-side inside the browser.


๐Ÿค Support

For help with setup or technical questions, contact us at:

๐Ÿ“ง support@typeswitch.net