...
1. Introduction
Purpose and Overview
...
🖇️ Navigation | |
|---|---|
|
Report Usage
This report comes in the form of table reports. It provides users with a comprehensive overview of worklogs associated with issues within a selected date range. Its primary objective is to display worklog data in a structured and user-friendly format, allowing users to track logged time efficiently.
2. Report Generation
Date Range Selection
When generating the Timesheet Report, users can select a specific date range using the integrated datepicker. The report will then display all issues that have worklogs within the chosen date range.
Grouping Selection
When generating the Timesheet Report, users can select a how they want the grouping of the table. There are two options, Grouping by user and Grouping by issues.
...
3. Table Structure
.png?version=1&modificationDate=1738684019850&cacheVersion=1&api=v2&width=760)
The Timesheet Report table consists of the following default columns:
...
Key/User
...
:
Key: If it is grouped by issues
...
display the parent key of each issue and a
...
summary. Contains a clickable issue key, by clicking on it the user will be redirected to this issue in Jira.
User: If the table is grouped by user it displays the Jira user name.
Priority: Displays the priority of certain issue.
Summary: Displays the summary of certain issue.
Logged: Displays the total logged time for each issue or user within the selected date range.
Date Columns: Includes columns for each day within the selected date range, displaying logged time for the issue on each respective day.
Cell Interaction
Each cell in the date columns containing worklog data is clickable. Clicking on a cell will open a modal window, providing a detailed view of the worklogs associated with that specific day. The modal will display information such as logged time, description, author, and any additional relevant details.
...
4. Customization
Grouping Options
...
Specific functionality:
At the top of the report card in the middle, we have a date bar swap, which allows user to quickly change the represented time frame.
At the top of the report card from the left side, we have the total number of issues within selected configurations.
Clicking on any column header will sort either from the highest to the lowest value, or from A to Z and vice versa.
The user is able to filter worklogs for a certain date by ascending by clicking on the date cell.
From the right side at the top, there is an issue search. User can filter issues by key or summary.
To check the list of worklogs for a certain date, the user can click on total for this date at the bottom of the table. A pop-up window with the list of worklogs of all Jira users for this day will appear. The window will display information such as date, Jira user name, issue, logged time, and description.
Depending on how issues are grouped. report can have two options to customize the display of data by grouping
...
either by
...
users or by
...
Grouped by User
When issues are grouped by user, the report will show a user table, indicating how much worklog each user has logged within the selected time period. Each users row in the table has issues collapsed. These issues can be viewed on the expand icon.
Grouped by Issue
...
issues.
When the report is grouped by users, clicking on a Jira user name will display a list of issues they have logged time on. To close this list, the user needs to click the same way on the Jira user name.
.png?version=1&modificationDate=1738683677441&cacheVersion=1&api=v2&width=760)
If report grouped by users, it includes an "Expand all rows" toggle that expands or collapses rows containing users with associated issues.
To check the list of worklogs for a certain Jira user for a certain date, the user can click on the square with a number of hours. A pop-up window with the list of worklogs of this Jira users for this day will appear. The window will display information such as Jira user name, date, issue, logged time, and description.
Setting up a report
The report has 4 tabs of configurations: Data source, Parameters, Display, Description.
Data source
Configure and manage the source of data for generating reports.
.png?version=1&modificationDate=1719313605656&cacheVersion=1&api=v2&width=362)
.png?version=1&modificationDate=1719313648686&cacheVersion=1&api=v2&width=362)
.png?version=1&modificationDate=1710403157420&cacheVersion=1&api=v2&width=567)
Parameters
Allow users to tailor the report to their specific needs and preferences.
.png?version=1&modificationDate=1719313724965&cacheVersion=1&api=v2&width=380)
Group by field is required. It has two options:
Issues: when issues are grouped by issue, the report will display worklogs for every user associated with that specific issue.
...
Conclusion
...
User: when issues are grouped by user, the report will show a user table, indicating how much worklog each user has logged within the selected period. When we select this field, “Users to display“ field appear.
The Period field is required. It lets the user select the time unit to customize the displayed users' time logs and issues on which time was spent. By default, it will be set as a week.
Display
This tab lets the user manage the display of columns in a table by adding, removing, or rearranging them.
.png?version=1&modificationDate=1719314083708&cacheVersion=1&api=v2&width=490)
The Columns block gives a user the possibility to customize the sequence of columns and remove unnecessary ones to suit their preferences for a personalized view of data.
Custom fields is a multi-select field. It allows users to add additional fields to sub-table columns.
Description
It serves as a space where users can provide context, explanations, and additional information about the report.
.png?version=1&modificationDate=1719314132706&cacheVersion=1&api=v2&width=634)
Description lets the user add any additional information no more than 500 characters about the created report.
The description will be presented directly on the report card (in case of its presence).