Filter (JQL): JQL (Jira Query Language) is a powerful tool for filtering and extracting data from Jira.
diff --git a/src/views/reports/say-do-ratio/ReportData.jsx b/src/views/reports/say-do-ratio/ReportData.jsx
new file mode 100644
index 00000000..0bdc9104
--- /dev/null
+++ b/src/views/reports/say-do-ratio/ReportData.jsx
@@ -0,0 +1,125 @@
+import React from 'react';
+import { Column, NoDataRow, ScrollableTable, TBody, THead } from 'src/components/ScrollableTable';
+import SayDoRatioChart from './SayDoRatioChart';
+import Indicator from '../../../components/worklog-indicator';
+import SprintInfo from './SprintInfo';
+import SprintStatusWiseTimeSpentChart from './SprintStatusWiseTimeSpentChart';
+
+const changeLogErrorMessage = "Unable to fetch change logs and hence data may not be accurate";
+
+function ReportData({ reportData, settings }) {
+ const [selectedSprint, setSprint] = React.useState();
+
+ return (<>
+
+
+
+ Board Name
+ Velocity
+ Say-Do-Ratio
+ Cycle Time
+ {loop(settings.noOfSprints, (i) => {
+ const sprintTitle = settings.noOfSprints === (i + 1) ? `Last sprint (n-1)` : `Sprint n${i - settings.noOfSprints}`;
+ return ({sprintTitle});
+ })}
+
+
+
+ {(b) =>
+ | {b.name} {b.logUnavailable && } |
+ {b.velocity || '-'} {!!b.velocity && ({parseFloat(b.velocityGrowth?.toFixed(2) || 0)}%)} |
+
+ {formatValue(b.sayDoRatio)}
+ {!!b.sayDoRatio && }
+ |
+ {b.averageCycleTime ? `${b.averageCycleTime} days` : '-'} |
+ {b.sprintList.map((s, index) => (s ? ( setSprint(s)} key={s.id}>
+
+ {!!s.sayDoRatio && {s.sayDoRatio}%}
+ {!s.sayDoRatio && -}
+ {!b.logUnavailable && s.logUnavailable && }
+ {!!s.sayDoRatio && }
+ | ) : - | ))}
+
}
+
+ {!reportData?.length && No data available.}
+
+
+
+
+ | Board Name |
+ Velocity |
+ Say-Do-Ratio |
+ Cycle Time |
+ {loop(settings.noOfSprints, (i) => {
+ const sprintTitle = settings.noOfSprints === (i + 1) ? `Last sprint (n-1)` : `Sprint n${i - settings.noOfSprints}`;
+ return ({sprintTitle} | );
+ })}
+
+
+ {loop(settings.noOfSprints, (i) => (
+ | Say-Do-Ratio |
+ Velocity |
+ Cycle Time |
+ ))}
+
+
+
+ {reportData.map((b) =>
+ | {b.name} |
+ {b.velocity} {!!b.velocity && ({parseFloat(b.velocityGrowth?.toFixed(2) || 0)}%)} |
+ {formatValue(b.sayDoRatio)} |
+ {formatValue(b.averageCycleTime, ' days')} |
+ {b.sprintList.map((s, i) => (
+ {formatValue(s?.sayDoRatio)} |
+ {formatValue(s?.velocity)} |
+ {formatValue(s?.cycleTime)} |
+ ))}
+
)}
+
+
+ {selectedSprint &&
+ setSprint(null)} />
+
}
+
+ {reportData?.map(b => <>
+
+
+ )}
+
+ );
+}
+
+export default ReportData;
+
+function formatValue(value, suffix = "%", defaultValue = '') {
+ return value ? `${value}${suffix}` : defaultValue;
+}
+
+function getLogClass(value, isSelected) {
+ if (!value) {
+ return isSelected ? 'text-center selected' : 'text-center';
+ }
+
+ let className = 'log-good';
+
+ if (value >= 85) {
+ className = 'log-good';
+ } else if (value >= 70) {
+ className = 'log-less';
+ } else {
+ className = 'log-high';
+ }
+
+ return `log-indi-cntr ${className}${isSelected ? ' selected' : ''}`;
+}
+
+function loop(num, callback) {
+ const result = [];
+
+ for (let i = 0; i < num; i++) {
+ result.push(callback(i));
+ }
+
+ return result;
+}
\ No newline at end of file
diff --git a/src/views/reports/say-do-ratio/ReportInfo.jsx b/src/views/reports/say-do-ratio/ReportInfo.jsx
new file mode 100644
index 00000000..846766f4
--- /dev/null
+++ b/src/views/reports/say-do-ratio/ReportInfo.jsx
@@ -0,0 +1,66 @@
+import React from 'react';
+import { isPluginBuild } from 'src/constants/build-info';
+
+function HelpText() {
+ return (
+
+
+ How to Use the Say Do Ratio Report
+
+ -
+ Say Do Ratio Report serves as a valuable tool to summarize achievements within each sprint and to monitor progress sprint over sprint.
+
+ -
+ Begin by selecting your filters and configuration options. Click on the icon located at the top right corner of the report to access report config:
+
+ - Select Sprint Boards: Choose all sprint boards for which you wish to view the report.
+ - Number of Sprints to Display: Specify the number of completed sprints you would like to include in the report. The minimum allowed is 3.
+ - Number of Sprints for Velocity: Indicate the number of sprints to be used for velocity calculations (min 3, max 9).
+ - Include Non-Working Days in Cycle Time Calculation: Decide if you want to include non-working days based on your General settings.
+
+
+ -
+ Once all configurations are set, click the "Generate Report" button to produce the report.
+ Be prepared for potential delays based on the number of boards and sprints selected.
+
+
+
+ Report Structure:
+ This report displays a comprehensive table summarizing all boards and sprints, along with individual charts for each board.
+ This report supports exporting data in Excel, PDF, and CSV formats.
+ User feedback for suggestions and bug reports is appreciated to enhance this report.
+
+
+ Table Structure:
+ The report table contains the following columns:
+
+ - Board Name: Name of the selected board.
+ - Velocity: Expected velocity for the upcoming sprint based on completed story points.
+ - Say-Do Ratio: Average Say-Do Ratio for the sprints included in the report.
+ - Cycle Time: Average cycle time calculated using specific configurations.
+ - Sprints: Each sprint is represented in individual columns, showing the average Say-Do Ratio for that sprint.
+
+
+
+
+
+ Important Note:
+
+
+ {!isPluginBuild && - This report requires access to change logs and utilizes a new API introduced by Jira, currently available only to Jira Cloud users. It is still in preview and not yet rolled out to all the Jira Instances.
}
+ {isPluginBuild && - This report requires access to change logs and utilizes a new API introduced by Jira, which is still in preview and not yet rolled out to all the Jira Instances.
}
+ - As it uses some of the API's which are still in preview, this report may not be functional for all Jira Instances immediately. Hence if it does not work then wait for few days so that your region gets the update from Jira.
+ - While there are no APIs to retrieve information about stories that were part of a sprint at its initiation, accurate calculation of the
+ Say-Do Ratio can be challenging if a story is removed during the sprint.
+ {!isPluginBuild && <> A workaround is implemented by using some of the Jira's internal API's, which is not available while you use oAuth authentication.}
+ {isPluginBuild && <> A workaround is implemented for upcoming sprints, but results for sprints that have already begun may not be precise.}
+
+ {!isPluginBuild && - Using the report with oAuth have lack of functionalities due to the above mentioned limitations.
}
+
+
+
+ );
+}
+
+export default HelpText;
diff --git a/src/views/reports/say-do-ratio/SayDoRatioChart.jsx b/src/views/reports/say-do-ratio/SayDoRatioChart.jsx
index aeef40b5..36533327 100644
--- a/src/views/reports/say-do-ratio/SayDoRatioChart.jsx
+++ b/src/views/reports/say-do-ratio/SayDoRatioChart.jsx
@@ -1,12 +1,26 @@
import { Chart } from 'primereact/chart';
import React from 'react';
+import { replaceRepeatedWords } from 'src/common/utils';
const documentStyle = getComputedStyle(document.documentElement);
const textColor = documentStyle.getPropertyValue('--text-color');
const textColorSecondary = documentStyle.getPropertyValue('--text-color-secondary');
const surfaceBorder = documentStyle.getPropertyValue('--surface-border');
-function getOptions(titleText, subTitle, minY, maxY) {
+function getOptions(titleText, subTitle, minY, maxY, xAxisLabels) {
+ const xAxis = {
+ ticks: {
+ color: textColorSecondary
+ },
+ grid: {
+ color: surfaceBorder
+ }
+ };
+
+ if (xAxisLabels.length > 4) {
+ xAxis.ticks.callback = (_, index) => xAxisLabels[index];
+ }
+
return {
maintainAspectRatio: false,
responsive: true,
@@ -47,14 +61,7 @@ function getOptions(titleText, subTitle, minY, maxY) {
intersect: false
},
scales: {
- x: {
- ticks: {
- color: textColorSecondary
- },
- grid: {
- color: surfaceBorder
- }
- },
+ x: xAxis,
y: {
title: {
display: true,
@@ -73,8 +80,10 @@ function getOptions(titleText, subTitle, minY, maxY) {
position: 'right',
title: {
display: true,
- text: 'Cycle Time (Days)'
+ text: 'Say Do Ratio (%)'
},
+ min: 0,
+ max: 100,
ticks: {
color: textColorSecondary
},
@@ -97,26 +106,18 @@ function getChartData(sprintList, key, label, borderColor, others) {
};
}
-function getCycleTimeData(sprintList) {
- return {
- label: 'Cycle Time',
- data: sprintList.map(({ averageCycleTime }) => averageCycleTime),
- backgroundColor: '#FFD700',
- yAxisID: 'y1',
- type: 'bar'
- };
-}
-
function SayDoRatioChart({ board }) {
const { data, options } = React.useMemo(() => {
const { name, sprintList, velocity } = board;
const availableSprints = sprintList.filter(Boolean);
const labels = availableSprints.map(s => s.name);
+ const shortenedLabels = replaceRepeatedWords(labels);
+
const datasets = [
getChartData(availableSprints, 'velocity', 'Velocity', '#4169E1', { borderDash: [5, 5] }),
getChartData(availableSprints, 'committedStoryPoints', 'Committed', '#FF6347'),
getChartData(availableSprints, 'completedStoryPoints', 'Completed', '#228B22'),
- getCycleTimeData(availableSprints)
+ getChartData(availableSprints, 'sayDoRatio', 'Say Do Ratio', '#c4a6ff', { yAxisID: 'y1', fill: true, backgroundColor: '#c4a6ff6b' })
];
let minY = 7, maxY = 7;
@@ -143,7 +144,7 @@ function SayDoRatioChart({ board }) {
return {
data: { labels, datasets },
- options: getOptions(name, `Velocity: ${velocity ?? '(Unavailable)'}`, minY, maxY + 2)
+ options: getOptions(name, `Velocity: ${velocity ?? '(Unavailable)'}`, minY, maxY + 2, shortenedLabels)
};
}, [board]);
diff --git a/src/views/reports/say-do-ratio/SprintStatusWiseTimeSpentChart.jsx b/src/views/reports/say-do-ratio/SprintStatusWiseTimeSpentChart.jsx
new file mode 100644
index 00000000..5033a5b7
--- /dev/null
+++ b/src/views/reports/say-do-ratio/SprintStatusWiseTimeSpentChart.jsx
@@ -0,0 +1,174 @@
+import { Chart } from 'primereact/chart';
+import React from 'react';
+import { replaceRepeatedWords } from 'src/common/utils';
+
+const documentStyle = getComputedStyle(document.documentElement);
+const textColor = documentStyle.getPropertyValue('--text-color');
+const textColorSecondary = documentStyle.getPropertyValue('--text-color-secondary');
+const surfaceBorder = documentStyle.getPropertyValue('--surface-border');
+const defaultLineColors = [
+ 'rgba(255, 99, 132)',
+ 'rgba(54, 162, 235)',
+ 'rgb(105 0 251)',
+ 'rgba(75, 192, 192)',
+ 'rgba(123, 12, 55)',
+ 'rgba(255, 159, 64)',
+ 'rgba(34, 33, 219)',
+ 'rgba(25, 100, 229)',
+];
+
+function getOptions(titleText, subTitle, minY, maxY, xAxisLabels) {
+ const xAxis = {
+ ticks: {
+ color: textColorSecondary
+ },
+ grid: {
+ color: surfaceBorder
+ }
+ };
+
+ if (xAxisLabels.length > 4) {
+ xAxis.ticks.callback = (_, index) => xAxisLabels[index];
+ }
+
+ return {
+ maintainAspectRatio: false,
+ responsive: true,
+ plugins: {
+ title: {
+ display: true,
+ text: titleText,
+ align: "center",
+ font: { size: '16px' },
+ padding: 0
+ },
+ subtitle: {
+ display: true,
+ text: subTitle,
+ padding: 10
+ },
+ legend: {
+ position: 'bottom',
+ labels: {
+ color: textColor
+ }
+ },
+ tooltip: {
+ mode: 'index',
+ intersect: false,
+ padding: 12,
+ boxPadding: 6,
+ callbacks: {
+ title: (tooltipItems) => `Sprint: ${tooltipItems[0].label}`,
+ label: (tooltipItem) =>
+ `${tooltipItem.dataset.label}: ${tooltipItem.formattedValue} days`
+ },
+ bodySpacing: 10
+ }
+ },
+ hover: {
+ mode: 'index',
+ intersect: false
+ },
+ scales: {
+ x: xAxis,
+ y: {
+ title: {
+ display: true,
+ text: 'Time Spent (days)'
+ },
+ min: minY,
+ max: maxY,
+ ticks: {
+ color: textColorSecondary
+ },
+ grid: {
+ color: surfaceBorder
+ }
+ },
+ y1: {
+ position: 'right',
+ title: {
+ display: true,
+ text: 'Cycle Time (Days)'
+ },
+ ticks: {
+ color: textColorSecondary
+ },
+ grid: {
+ drawOnChartArea: false
+ }
+ }
+ }
+ };
+}
+
+function getChartData(sprintList, key, label, borderColor, others) {
+ return {
+ label,
+ data: sprintList.map(s => s.statusWiseTimeSpent[key] || 0),
+ fill: false,
+ borderColor,
+ tension: 0.4,
+ ...others
+ };
+}
+
+function getCycleTimeData(sprintList) {
+ return {
+ label: 'Cycle Time',
+ data: sprintList.map(({ averageCycleTime }) => averageCycleTime),
+ backgroundColor: '#FFD700',
+ yAxisID: 'y1',
+ type: 'bar'
+ };
+}
+
+function SprintStatusWiseTimeSpentChart({ board }) {
+ const { data, options } = React.useMemo(() => {
+ const { name, sprintList, boardColumnsOrder } = board;
+ const availableSprints = sprintList.filter(Boolean);
+ const labels = availableSprints.map(s => s.name);
+ const shortenedLabels = replaceRepeatedWords(labels);
+ const statusList = availableSprints.flatMap(s => Object.keys(s.statusWiseTimeSpent)).distinct().sortBy(s => boardColumnsOrder[s] ?? 10);
+ const datasets = statusList.map((s, i) => getChartData(availableSprints, s, s, defaultLineColors[i]));
+ datasets.push(getCycleTimeData(availableSprints));
+
+ let minY = 2, maxY = 4;
+
+ for (const ds of datasets) {
+ if (ds.yAxisID !== 'y1') {
+ for (const val of ds.data) {
+ if (val < minY) {
+ minY = val;
+ }
+
+ if (val > maxY) {
+ maxY = val;
+ }
+ }
+ }
+ }
+
+ if (minY <= 1) {
+ minY = -1;
+ } else if (minY <= 2) {
+ minY = 0;
+ } else {
+ minY -= 1;
+ }
+
+ return {
+ data: { labels, datasets },
+ options: getOptions(name, `Status Wise Time Spent`, minY, maxY + 1, shortenedLabels)
+ };
+ }, [board]);
+
+ return (
+
+
+
+ );
+}
+
+export default SprintStatusWiseTimeSpentChart;
\ No newline at end of file
diff --git a/src/views/reports/say-do-ratio/helper.js b/src/views/reports/say-do-ratio/helper.js
index 69b82f8a..311b6290 100644
--- a/src/views/reports/say-do-ratio/helper.js
+++ b/src/views/reports/say-do-ratio/helper.js
@@ -10,17 +10,24 @@ export function getSprintWiseSayDoRatio(settings) {
await $config.saveSettings(settingsName, { sprintBoards, noOfSprints, velocitySprints, includeNonWorkingDays });
const customFields = await $jira.getCustomFields();
+ const statuses = await $jira.getJiraStatuses();
+
+ const statusMap = statuses.reduce((map, s) => {
+ map[s.id] = s.untranslatedName || s.name;
+ return map;
+ }, {});
+
const sprintFieldId = customFields.find(({ name }) => name === 'Sprint')?.id;
- progress({ data: [], completed: 5 });
+ progress({ data: [], completed: 2 });
const workingDaysToUse = includeNonWorkingDays ? undefined : workingDays;
const result = [];
for (const { id, name } of sprintBoards) {
const { closedSprintLists, ...boardProps } = await $sprint.computeAverageSprintVelocity(id,
- velocitySprints, storyPointField, sprintFieldId, noOfSprints + velocitySprints, workingDaysToUse)
+ velocitySprints, storyPointField, sprintFieldId, noOfSprints + velocitySprints, workingDaysToUse, statusMap)
.progress(({ completed }) => {
- progress({ completed: 5 + (((result.length + (completed / 100)) * 95) / sprintBoards.length) });
+ progress({ completed: 2 + (((result.length + (completed / 100)) * 98) / sprintBoards.length) });
});
const sprintList = closedSprintLists.slice(-noOfSprints);
diff --git a/src/views/reports/say-do-ratio/index.jsx b/src/views/reports/say-do-ratio/index.jsx
index 316dbf42..89e7b260 100644
--- a/src/views/reports/say-do-ratio/index.jsx
+++ b/src/views/reports/say-do-ratio/index.jsx
@@ -3,19 +3,14 @@ import { getSprintWiseSayDoRatio, getSettings } from './helper';
import GadgetLayout from '../../../gadgets/Gadget';
import ReportSettings from './settings';
import useToggler from 'react-controls/hooks/useToggler';
-import { Column, NoDataRow, ScrollableTable, TBody, THead } from 'src/components/ScrollableTable';
-import SayDoRatioChart from './SayDoRatioChart';
-import Indicator from '../../../components/worklog-indicator';
import { Button } from '../../../controls';
-import SprintInfo from './SprintInfo';
+import HelpText from './ReportInfo';
+import ReportData from './ReportData';
import './SayDoRatioReport.scss';
-const changeLogErrorMessage = "Unable to fetch change logs and hence data may not be accurate";
-
function SayDoRatioReport() {
const [isLoading, setLoader] = React.useState(false);
const [progress, setProgress] = React.useState();
- const [selectedSprint, setSprint] = React.useState();
const [editMode, toggleEdit] = useToggler(true);
const [settings, updateSettings] = React.useState(getSettings());
const [reportData, setReportData] = React.useState([]);
@@ -26,7 +21,6 @@ function SayDoRatioReport() {
const loadReportData = React.useCallback(async () => {
try {
setProgress(0);
- setSprint(null);
setReportData([]);
setLoader(true);
const reportData = await getSprintWiseSayDoRatio($this.current.settings).progress(({ completed, data }) => {
@@ -60,114 +54,11 @@ function SayDoRatioReport() {
isGadget={false} isLoading={isLoading} loadingProgress={progress}
onRefresh={loadReportData} customActions={customActions}
>
-
-
-
- Board Name
- Velocity
- Say-Do-Ratio
- Cycle Time
- {loop(settings.noOfSprints, (i) => {
- const sprintTitle = settings.noOfSprints === (i + 1) ? `Last sprint (n-1)` : `Sprint n${i - settings.noOfSprints}`;
- return ({sprintTitle});
- })}
-
-
-
- {(b) =>
- | {b.name} {b.logUnavailable && } |
- {b.velocity || '-'} {!!b.velocity && ({parseFloat(b.velocityGrowth?.toFixed(2) || 0)}%)} |
-
- {formatValue(b.sayDoRatio)}
- {!!b.sayDoRatio && }
- |
- {b.averageCycleTime ? `${b.averageCycleTime} days` : '-'} |
- {b.sprintList.map((s, index) => (s ? ( setSprint(s)} key={s.id}>
-
- {!!s.sayDoRatio && {s.sayDoRatio}%}
- {!s.sayDoRatio && -}
- {!b.logUnavailable && s.logUnavailable && }
- {!!s.sayDoRatio && }
- | ) : - | ))}
-
}
-
- {!reportData?.length && No data available.}
-
-
-
-
- | Board Name |
- Velocity |
- Say-Do-Ratio |
- Cycle Time |
- {loop(settings.noOfSprints, (i) => {
- const sprintTitle = settings.noOfSprints === (i + 1) ? `Last sprint (n-1)` : `Sprint n${i - settings.noOfSprints}`;
- return ({sprintTitle} | );
- })}
-
-
- {loop(settings.noOfSprints, (i) => (
- | Say-Do-Ratio |
- Velocity |
- Cycle Time |
- ))}
-
-
-
- {reportData.map((b) =>
- | {b.name} |
- {b.velocity} {!!b.velocity && ({parseFloat(b.velocityGrowth?.toFixed(2) || 0)}%)} |
- {formatValue(b.sayDoRatio)} |
- {formatValue(b.averageCycleTime, ' days')} |
- {b.sprintList.map((s, i) => (
- {formatValue(s?.sayDoRatio)} |
- {formatValue(s?.velocity)} |
- {formatValue(s?.cycleTime)} |
- ))}
-
)}
-
-
- {selectedSprint &&
- setSprint(null)} />
-
}
-
- {reportData?.map(b => )}
-
+ {!reportData?.length &&
}
+ {reportData?.length > 0 &&
}
);
}
export default SayDoRatioReport;
-
-function formatValue(value, suffix = "%", defaultValue = '') {
- return value ? `${value}${suffix}` : defaultValue;
-}
-
-function getLogClass(value, isSelected) {
- if (!value) {
- return isSelected ? 'text-center selected' : 'text-center';
- }
-
- let className = 'log-good';
-
- if (value >= 85) {
- className = 'log-good';
- } else if (value >= 70) {
- className = 'log-less';
- } else {
- className = 'log-high';
- }
-
- return `log-indi-cntr ${className}${isSelected ? ' selected' : ''}`;
-}
-
-function loop(num, callback) {
- const result = [];
-
- for (let i = 0; i < num; i++) {
- result.push(callback(i));
- }
-
- return result;
-}
\ No newline at end of file
diff --git a/src/views/reports/sprint-report/SprintWiseWorklog.jsx b/src/views/reports/sprint-report/SprintWiseWorklog.jsx
index ab8cd9e1..9b83d54a 100644
--- a/src/views/reports/sprint-report/SprintWiseWorklog.jsx
+++ b/src/views/reports/sprint-report/SprintWiseWorklog.jsx
@@ -330,7 +330,7 @@ class SprintWiseWorklog extends PureComponent {