This article explains why and how to use the Worklogs/Comments tab type within a report.
Why should you use this tab type?
The Worklogs tab type serves two main purposes.
First, it lets you create reports focused on work item comments. For Jira Service Management spaces, you can distinguish between internal and external comments. You can also tabulate the number of comments, by type, per work item or by any other available field.
Second, if you use Jira time tracking, the Worklogs tab lets you analyze time logged for a work item by user and by time interval. Unlike the Pivot tab, it allows you to filter worklogs directly based on who logged the time and when it was logged.
In addition, the Worklogs tab provides more advanced analysis capabilities than the Worklog Report available on the Atlassian Marketplace.
What is the difference between Time Spent and Time Logged?
Time Spent represents how much of the original estimate has been consumed. It is mainly used as a progress indicator to show how much work has been completed relative to what was planned.
Time Logged represents the actual work recorded by users during a specific period. You obtain Time Logged by filtering Time Spent using a defined time interval.
For example, if you want to see how much time was logged during the last sprint, you can set an interval that matches the sprint’s start and end dates. The filtered result shows the time logged only within that period.
Features and use cases
How can you configure the Worklogs tab?
The Worklogs tab type includes the following options for configuring the table located within Summary section.
-
Name and type: Click inside the text box to rename the selected tab.
-
Rows, Columns, and Values: Check these options to modify the contents of the Summary section for the selected tab.
-
Breakdown: Click on the toggle switch to either hide or show the Breakdown section within the selected tab. This options is available for Pivot, Capacity, Worklogs, and Warnings tab types.
-
Display options: Check Show slices, Show progress, or both, to show these sections within the selected tab.
-
Interval: Set Start and End dates for the period being filtered.
Rows, Columns, and Values are introduced further below.
Rows
The options shown in the screenshot allow you to reorder, remove existing rows, or add new ones.
-
Activate a row: Click Add Row, open the dropdown menu, and select the row you want to add.
-
Remove a row: Click the bin icon on the row card to remove it.
-
Reorder a row: Drag the row using the grid icon (the dotted handle on the left side of the card) to change its position.
-
Check display options: Select the appropriate checkbox to hide rows with no work items, either when switching between slices or across all slices, including the All Work items slice.
Columns
The options shown in the screenshot let you manage columns by reordering them, removing existing ones, adding new ones, hiding default columns, or grouping column values.
-
Activate a column: Click Add Column, open the dropdown menu, and select the column you want to add.
-
Remove a column: Click the bin icon on the column card to remove it.
-
Reorder a column: Drag the column using the grid icon (the dotted handle on the left side of the card) to change its position.
-
Sort a column: Open the column’s dropdown menu and choose how to sort the column: by order, work item count, or value (based on the column subtotal). Then select whether the sorting should be ascending or descending. If multiple column cards are present, only the column shown in the top card will be sorted.
Fields such as Status, Priority, and Work item Type follow the ranking defined in Jira settings, which you can customize. Date fields are sorted chronologically when ascending order is selected.
-
Column display options: Select the relevant checkbox to hide default columns in the Summary section, such as those showing work item counts or row totals.
-
Value grouping: Enable Grouping to group column values. This option is available when you use date-based fields, such as comment date, worklog date, or due date, as well as number-based fields like comments, story points, or other numeric fields. If multiple column cards are present, only the column shown in the top card is grouped.
For date fields, values can be grouped by one week, two weeks, one month, one quarter, or one year. You can define the start and end dates manually or allow them to be set automatically.
For number-based fields, such as comments or story points, values are grouped using a number that defines the step between each group. Start and end values can also be set manually or left to auto-set. Only whole numbers can be entered.
Values
The options shown in the screenshot let you control the contents of each cell in the table created from rows and columns.
-
Select a value: Open the dropdown menu and choose the value to display in the table. In the Worklogs tab, the only available values are Time Logged and All Comments, which represents the total number of comments.
When the app is used with Jira Service Management, additional values become available: External, Internal, Agent, and Customer Comments. Each of these values shows the comment count for its category. By default, all customer comments are treated as external.
-
Choose how values are displayed: Decide whether the value appears as a number, as a percentage, or as a combined Value | Percent in the same cell. You can also choose to hide the work item count shown alongside the value.
-
Define percentage calculation: When using Percent or Value | Percent, specify how the percentage is calculated. Each cell can show a percentage based on the grand total of the table (all rows and columns), the row total, or the column total.
Interval
The options shown in the screenshot let you control the time period used for filtering.
-
Start date: Select the start date of the interval using the calendar or by entering a date in the text box.
-
End date: Select the end date of the interval using the calendar or by entering a date in the text box.
-
Count: Defines the length of the interval. In the example, the interval spans two weeks. When start and end dates are set manually, this field is empty and not used.
-
Unit: Specifies the unit of time used with the count value, such as weeks in the example. When start and end dates are set manually, this field is empty and not used.
-
Offset: Determines whether the current time period is included or whether an offset is applied.
In the example, the current week is excluded and the interval is shifted back by one week, starting in the previous week relative to today. When start and end dates are set manually, this field is empty and not used.
-
Apply: Once you’ve made your changes to the interval, click Apply.
FAQ
Troubleshooting
If you have questions or need assistance, contact our support team via email or service desk. Our team is available Monday through Friday (9:00 AM to 7:00 PM GMT+7) to help with technical challenges or discuss improvements.