Timetracker Plugin for JIRA enables its users to log their working hours in a fast and easy manner. The plugin provides users a simple and easy-to-use interface to manage their worklogs, and create useful reports from their worklog entries. Worklogs can be created, modified, copied or deleted.
Install
The plugin can be downloaded or installed from Atlassian Marketplace. 
Login
To use the plugin, it is necessary to log into JIRA. After authentication, the plugin can be found amongst the JIRA menu items by the name of Timetracker.
Timetracker plugin interface and input fields
The interface consists of different parts: the date modification part, the worklog total part, the worklog table part and the input fields.
Timetracker plugin use the JIRA Look and feel settings (Complete Date/Time Format and Day/Month/Year Format) to display dates.
Date modification
Based on the user settings, there are more options to modify the date. The pop-up calendar and the tools to modify the date can be found in the top left-hand corner. It is possible to increase or decrease the date with units of time (day, week, month). Besides, a date can be chosen from the pop-up calendar also. The inline calendar can be found below the worklog table on the right-hand side of the input fields block. The settings make it possible to use both types of calendars simultaneously.
The Calendar highlights funtion
The calendar coloring function has been extended. The exclude dates shows like weekend (colored with red). The other months weekend fonts is colored to pink. The dates that include worklog now appears with yellow background.
Worklog total
The worklog summary can be found in the top right-hand corner and it can be viewed in JIRA format ( d h m) broken down to a given day, week or month. In the case of a given day, the summary is created from 00:00:00 to 23:59:59. In the case of a given week, the summary is created from Monday 00:00:00 to Sunday 23:59:59. A monthly summary is created from the first day of the month 00:00:00 to the last day of the month 23:59:59. The worklogs related to actual work are summarized below the worklog summary. This Real Work Summary contains only the time spent with actual work based on the worklogs that are not related to non-working issues. The Real Work Summary uses JIRA format (d h m) to display the daily, weekly and monthly summaries.
Worklog table
In the worklog table, the worklogs belonging to the given day can be viewed. A row belongs to each worklog. The table has the following columns:
-
Issue - Issue code to which the worklog belongs. If the pointer hovered above the isseId, the issue description will appear. By clicking on it, the issue can be viewed. If it is closed, the Issue code get strikethrough.
-
Remaining - Remaining time on the issue in JIRA format (d h m). If Issue is not closed and if there is no more estimated time assigned to it, the remaining time becomes red. If the Issue is closed, the remaining time becomes grey.
-
Start - Start date of the worklog. Its format: hh:mm.
-
End - End date of the worklog: Its format: hh:mm.
-
Duration - Duration of the worklog; the time between the start and the end date in JIRA format (d h m).
-
Note - Description of the worklog.
-
Actions - It contains action buttons: Edit button - After pressing it, the given worklog can be edited. Delete button - After pressing it, the given worklog is deleted. Copy button - After pressing it, the given worklogs Issue and Note field are copied to the Input fields.
The worklogs are ordered by the start date. If no worklog belongs to the given date, then the “No data to display!” message appears under the table header.
The input fields can be seen in the bottom of the page. These fields are used when editing worklogs.
-
Change Date For All - It may be used to edit the worklog of a whole day. By means of this option, all the worklogs assigned to a specific date can be reassigned to another one. You may read more about the Change Date For All function under the Edit Worklog menu item.
-
Start Time - Start time of the worklog. Required! Its format: hh:mm. Its default value is 08:00, however, if there are worklogs belonging to the given day, then its value equals the end date of the last worklog.
- Pressing the Now button first, the current time can be set as a value. Pressing the Now button second and third times the button rounding function will round the time with the setted values first up then down.
-
Issue - The issue to which the worklog will belong. Required! The field can be filled in in two ways:
- Typing the issue code or summary in the field. The autocomplete function will display the issues matching the typed text.
- By clicking on the cross beside the issue field, the users can select one of the issues they viewed most frequently.
In the issue field there are more issues listed but it is always the first one that is selected. Issues can be removed from the input field by clicking on the X next to them.
-
End Time - End time of the worklog. It is optional, but either the End time or the Duration field has to be filled in. Its format: hh:mm. Its value is the current time by default. The value of the end time cannot be smaller than the start time.
- By pressing the Now button first, the current time can be set as a value. Pressing the Now button second and third times the button rounding function will round the time with the setted values first up then down.
-
Duration - Duration of the worklog. It is optional, but the End time or the Duration field has to be filled in. Its format: hh:mm or Xh XXm. The value cannot exceed the value of 24:00-Start Time.
-
Note - The worklog description can be given in the note field. The note input field handles the text formatting annotations. The available toolbar appears on JIRA 6.4.x or later.
The Issue and Note field can be copied from the Worklog table by clicking one of the worklogs appropriate cell. With this technique you can also copy the Start and End time field but in that case the values will be switched. This can be useful when you want to fill a hole between two worklogs.
Create Worklogs
A worklog can be created by appropriately filling in the necessary input fields and clicking on the Submit button. Then, the worklog will be displayed in the worklog table.
Edit Worklogs
Worklogs belonging to a particular day can be edited. To do so, in the worklog table, the Edit button after the worklog needs to be pressed. After pressing the button the worklog data are displayed in the input field where they can be modified. The changes can be saved by pressing the Save button replacing the Submit button. The input field values are obliged to the same criteria as in the case of worklog creation. If one of the fields does not meet the requirements, an error message is sent and the changes do not take effect. Editing can be cancelled by pressing the Cancel button.
Change Date For All function
The Change Date For All button can be found below the worklog table, and it can be used to edit all the worklogs assigned to a particular day. In this case, only the date of the worklogs can be changed. After selecting the desired date, one may save the worklogs by clicking the Save button. At this time, the worklogs will no longer be assigned to the previous date. The edit procedure can be cancelled by pressing the Cancel button.
Copy Worklogs
Worklogs belonging to a given day can be copied. After pressing the copy button the worklog data are displayed with yellow background. You can now navigate to an other day and copy the worklog data by clicking on the Submit button.
Delete Worklogs
Worklogs belonging to a given day can be deleted. To do so, in the worklog table, after the worklog the Delete button needs to be pressed. Then, the worklog is deleted from the table and the system as well.
Settings
The plugin customization has multiple levels. Some settings depend upon a particular person (usually appearance related settings). Others affect all the users of the plugin (administrator settings).
User settings
The settings may be saved by means of the Save button. By clicking the Reset button, the foregoing settings can be restored. If the user selects the Cancel button, then he is redirected to the Timetracker page. In this case, none of the changes will be saved.
Calendar appearance
Users may set up the appearance and the start date of the calendar. The appearance types of the calendar are listed below:
-
Popup - Popup style calendar placed above the worklog table.
-
Inline - The calendar is placed next to the input fields.
-
Both types of calendars - The calendar appears in both places.
The start date of the calendar may also be defined. There are two options to do this:
-
Current Date - The current date will be set up as the default value.
-
Last Unfilled Date - Returns the oldest blank day of the past week by default. if each and every day is logged appropriately, then the current day is returned. When determining the oldest blank day, the plugin considers the list of exclude and include dates.
The calendar highlights function can be turned on and off.
There is a system setting to change the calendars first day of the week, located in:
"system admin->look and feel->Use ISO8601 standard in Date Picker"
Input fields settings
This part of the settings the StartTime field and the EndTime field Now button rounding function can be configured. In both cases the rounding rate can be a predetermined value. The acceptable values are 5, 10, 15, 20, 30 minutes.
Global settings
The global settings are administrator settings and they manipulate how the plugin works.
Accessing the global settings
Global settings may be accessed only by the system administrators. The administrator can find the Global settings menu item on the Administrator page under the Plugins or Add-ons menu in the Timetracker submenu.
Non-Working issues
The administrator can define a list that may contain issue keys and regular expressions. This list will be the list of non-working issues. The issues listed here are ignored when creating the Real Work Summary. By default, the Non-Working issues list is empty.
Non-Estimated issues
The administrator can define a list that may contain issue keys and regular expressions. This list will be the list of Non-Estimated issues. The issues listed here do not trigger the appearance of the red exclamation mark and they are ignored when sending notification e-mails too. All the issues are non-estimated by default. This can be achieved by setting upf a .* regular expression. Example: To set up all the issues of MYPROJECT to be Non-estimated, the following regular expression needs to be used: “MYPROJECT-.*”.
Working days
By default, weekdays are working days and weekends are non-working days. The administrator can define the list of days that are exceptions to the rule; these lists are empty by default. The format of the dates is yyyy-MM-dd (e.g.: 2013-01-01), the separator character is “,”.
-
Exclude date - List of those days that are working days by default, but they are not counted as such (e.g.: National Holidays).
-
Include date - List of those days that are non-working days by default, but they are counted as working days.
The settings can be saved by pressing the Save button. The Reset button can restore the foregoing settings. By selecting the Cancel button, the user is redirected to the Administrator screen without making any changes.
Missing Days Report
By the help of the Missing Days Report tab, all the days without assigned worklogs are returned between the given dates. The list displays 20 dates simultaneously. Further results can be viewed by the help of the paging buttons in the bottom. Clicking on a date in the list, one may navigate to the Timetracker interface of the plugin.
On the report page, the start and end date of the query can be chosen. The query is executed after pressing the Search button. The date in the From field is considered from 00:00, whereas the date in the To field is considered till 23:59. By default, the value of the From field is a date being a month earlier than the current date, while the value of the To field is the current date.
The report lists the days where the worklogs spent time is less than the configured numer of working hours per day. This report is available if the first checkbox is checked. An other options in this case if the query not exclude the non-working issues, for this type of query the second checkbox have to be checked. The second checkbox is blocked if the first one is not activated.
Chart report
By the help of the Chart Report tab, a pie chart is returned showing the logged work hours by projects between the given dates for the given user.
On the report page, the start and end date of the query can be chosen. Also you can select which users worklogs are you interested in. The query is executed after pressing the Search button. The date in the From field is considered from 00:00, whereas the date in the To field is considered till 23:59. By default, the value of the From field is a date being a week earlier than the current date, while the value of the To field is the current date. The default user is the currently logged in user. You can search for other users by typing in the starting characters of their username, full name or email address.
You can filter out any unwanted project with the dashboard appearing on the left of the chart, the results will update immediately.
There is a permission check in the query, so you will only see those projects in the chart which you have permisson to browse.
Table report
With the help of the Table Report tab, a table is returned showing the saved worklogs between the given dates for the given user.
The displayed table contains the following data of the worklogs: Date, Issue key, Remaining, Start time, End time, Duration, Worklog note.
After each day/week/month there are a summary row which shows the total of the worklogs for the interval.
The "Real work" field does not count the projects defined at the Non-Working issues setting.
On the report page, the start and end date of the query can be chosen. Also you can select which users worklogs are you interested in. The query is executed after pressing the Search button. The date in the From field is considered from 00:00, whereas the date in the To field is considered till 23:59. By default, the value of the From field is a date being a week earlier than the current date, while the value of the To field is the current date. The default user is the currently logged in user. You can search for other users by typing in the starting characters of their username, full name or email address.
There is a permission check in the query, so you will only see those projects in the chart which you have permisson to browse.
Reporting
Create detailed reports with multiple search criteria or one of your favorite filters and view every work log related to the users and additional information about the projects and the issues.
Administration Settings
The Reporting administration settings may be accessed only by the system administrators. The administrator can find the Reporting settings menu item on the Administrator page under the Plugins or Add-ons menu in the Timetracker submenu.
Permission to use Reporting
By default all users have permission to view and use Timetracker Reporting. If you would like to restrict usability, you can add JIRA groups here that have permits to view and use Reporting.
Permission to browse others worklogs
By default, each user has permission to browse other users' worklogs. Add groups if you want to restrict this functionality. Users who do not belong to one of the given groups can only see their own worklogs.
User Settings
You can find the user settings menu item in the upper right corner of the Reporting page.
Page size
You can set the initial page length of Worklog details and Quick summary reports. This option will change the number of rows to display on a single page in the reports.
Show pop-ups
Check this to show the tutorial/what's new pop-ups when you open reporting. Note that this setting may change after version update to make sure you get notified of the new features.
Search criteria
Dynamic queries for work log reporting. Timetracker Reporting provides the main search criteria which you already know from the JIRA Issue Navigator and with a similar look and feel. You can search for projects, issues and worklogs and for their properties. You can define your search criteria in two way: using the basic search or search with one of your favorite filters.
You can search by users to find all worklogs related to the selected user(s). You can also search by groups. In this case you can get all worklogs that belong to users within groups. Note: The two search terms are exclusive, so the user and group criteria cannot be used simultaneously. It is also possible to run your parameterised search for a specified time range.
Time Tracking Details
In this section you can see the detailed data according to the search. Each row represents one worklog and every row contains the basic information about the project and the issue which the worklog belongs to. You can display additional columns to see the information that you need in the report.
Export
Timetracker Reporting enables you to export your search results from this section to Microsoft Excel. You can export all columns at once, or just the ones that you displayed.
Quick Summary
In this section you can see the summary information about projects, issues and users. Under every tab, each row also displays the total logged times based on its dimension. The grand total of the logged times can be found here too.
Export
You can export the summarized data from this section to Microsoft Excel.
Notification email
By default, the plugin sends every day at 20:00 a notification email about the issues to which worklogs have been assigned if the estimated time of the issues is over and if the issues have not been closed. The notification email is delivered to the reporter of the issue and to the project manager. If multiple worklogs have been assigned to one issue, they have exceeded the Estimated Time and they have not been closed, then the plugin will send only an email. The plugin does not send emails about issues that are defined as non-estimated in the global settings.
Error messages
If the input fields are filled in incorrectly, the following error messages will be displayed:
- Time fields filled in erroneously:
- In case the start time is invalid: Invalid Start Time!
- In case the end time is invalid: Invalid End Time!
- In case the duration is invalid: Invalid Duration Time!
- In case the start and end times are given erroneously: Invalid Time Interval!
- Issue input fields and issue errors:
- In case of a missing parameter: Missing Issue Parameter!
- In case an issue key is given erroneously: Wrong Issue: issue-key
- In case of lacking permissions: You don't have permission to the issue: issue-key
- Error messages during creating, editing or deleting worklogs:
- In case of unsuccessful date processing: You can't parse the date: wrong-date
- In case of unsuccessful worklog creation: Unsuccessful worklog creation.
- In case of unsuccessful worklog update: Unsuccessful worklog update.
- In case of unsuccessful worklog deletion: Can't delete worklog with this ID: worklog-id
Analytics
In order to enhance the features of the add-on, we need to understand how our customers use Timetracker. To achieve this, we would like to collect anonymous data about the usage of this plugin:
- Anonymized IP address (to be able to create statistics about the usage in the different countries)
- Hash of the domain address of the JIRA system (we will not know your domain address)
- Hash of the user (we will not know your original user id)
- Usage count of the time tracking feature
- Usage count of the Missing Days Report
- Usage count of the Chart Report
- Usage count of the Table Report
- User Agent of the browser being used
- Timetracker version number
- JIRA version number
This option is on by default, but you can switch it off on the Global settings page.
Feedback
Your thoughts about Timetracker are very important to us, so we built in an easy feedback feature. You can find the feedback button in the right bottom on each pages, and in the upper right on the Global settings page.
On the feedback dialog:
- Please Rate this add-on by selecting one of the stars.
- Tell us what do you like or what needs to be improved. This is mandatory.
- Provide your e-mail address if you would like us to contact you about your feedback. (We will not use your email for any other purpose and we will never share it with any third party company.)
Versions and compatibility
Due to the introduction of the Reporting feature we had to split the latest Timetracker plugin to two versions.
Timetracker versions and compatibility:
- The 3.x version of the plugin has the same functionality as the 2.4.x or later version and compatible with JIRA 7.x and above.
- The 2.4.x or later version of the plugin compatible with JIRA 6.3.0 to 6.4.13
- The older Timetracker 2.2.0 to 2.3.5 versions of the plugin compatible with JIRA 6.2.5 to 7.x, but these versions do not contain the Reporting feature.
- The version 1.x is compatible with older Jira versions but it uses tricks to achieve the same goals (e.g.: native SQL expressions). Version 1.x will be supported until the rate of deployments is dropped below 15%.
Release notes
Timetracker version 3.1.1
Bugfix
- Reporting Export limit/offset fixed.
Timetracker version 2.5.1
Bugfix
- Reporting Export limit/offset fixed.
Timetracker version 3.1.0
Improvements
- Added new permission settings option.
- Introducing Reporting user settings.
- Remember columns selected by the user in Reporting.
- Added information and warning messages.
Bugfix
- Database Error: Invalid column name 'userDispalyName' fixed. () ()
- Database Error: "ISSUE"."ASSIGNEE": invalid identifier fixed.
- Invalid Issue Key handling fixed.
Timetracker version 2.5.0
Improvements
- Added new permission settings option.
- Introducing Reporting user settings.
- Remember columns selected by the user in Reporting.
- Added information and warning messages.
Bugfix
- Database Error: Invalid column name 'userDispalyName' fixed. () ()
- Database Error: "ISSUE"."ASSIGNEE": invalid identifier fixed.
- Invalid Issue Key handling fixed.
Timetracker version 3.0.1
Bugfix
- Shadowed users error fixed. ()
- 'avatarId' based icons load error fixed.
Timetracker version 2.4.1
Bugfix
- Shadowed users error fixed. ()
- 'avatarId' based icons load error fixed.
Timetracker version 3.0.0
Improvements
- New reporting feature.
- Added jira-querydsl-support.
Changes
- Compatible with JIRA 7.x and above.
Timetracker version 2.4.0
Improvements
- New reporting feature.
- Added jira-querydsl-support.
Changes
- Compatible with JIRA 6.3.0 to 6.4.13.
Timetracker version 2.3.5
Bugfix
- Chart and Table report user picker error fixed.
- Admin settings shows wrong error message fixed.
- Missings worklog "work hours per day" error fixed.
Timetracker version 2.3.4
Hotfix
- Look and Feel dateparser bugfix.
- Exclude/Include date settings bugfix.
- User picker refactor.
Timetracker version 2.3.3
Bugfix
- Use Jira Look and feel Complete Date/Time Format and Day/Month/Year Format.
- Use the fractions correctly if they were specified in the JIRA Time Tracking Configuration. ()
- Fixed EveritWorklog NullPointerException.
Timetracker version 2.3.1
Bugfix
- Use the fractions if they were specified in the JIRA Time Tracking Configuration. ()
Changes
- Feedback frequency session check.
Timetracker version 2.3.0
Bugfix
- Respect JIRA Time Tracking Configuration. ()
- Fix text area under JIRA 6.4.x.
- Show error message instead of error page if issue is in Done state, and work logging is prohibited.
- Do not show error page if installed on JIRA without a project.
Improvements
- New navigation menu. Add Help and Administration item.
- Wrap long content.
- Preservation of data on the pages.
- Highlight worklog data when copying.
- If Issue is in Done state, the Issue code get strikethrough and the remaining time becomes grey.
- Add Remaining column to the Table Report.
- More informative error page.
Timetracker version 2.2.0
Bugfix
- Fixed duration validation error.
- Fixed labels missing for unsupported languages. ()
- Fixed worklog text area style.
- Fixed parameter misspelling.
- Fixed change date and submit action, without logged work.
- Fixed sticky command parameters.
- Added error message for invalid time while editing worklog.
Changes
- Support for JIRA 7.
- Change Edit, Delete and Copy buttons to icons.
- Added remaining estimate column.
- Added analytics tool.
- Added feedback feature.
Timetracker version 1.4.3
Bugfix
- Fixed labels missing for unsupported languages. ()
- Fixed change date and submit action, without logged work.
Changes
Timetracker version 2.1.2
Bugfix
- Fixed bug when Enter key is pressed at the issueselect area and therefore the save button turned to disabled state.
Improvements
- Enter key now jumps to the next input field.
- Ctrl+Enter on input fields now submits the actual form.
Timetracker version 2.1.1 and 1.4.1
Improvements
Changes
- License changed from LGPL 3.0 to Apache 2.0
- From now on the plugin version 2.1.1 requires Java 1.7
Timetracker version 2.1.0 and 1.4.0
New features
- Table report page to show the worklogs in a table in the given time interval.
- Added project filtering capability to the chart report.
Bugfix
- Duration field accepts inputs like "90m". ().
- Prevented multiple form submit. ().
- Correct handling of users with changed email address (v1.4.0).
Timetracker version 2.0.0
Changes
- In this version we changed the way of querying the worklogs from native sql to API calls. To do this with a satisfying speed we need a new view in the entity model called "IssueWorklogView" which is introduced in JIRA 6.2.5.
- Therefore this version is only available with JIRA versions above 6.2.5.
- From now on we will only develop the 2.x.x version of the plugin and no new features will be introduced in the 1.x branch
Timetracker version 1.3.0
Bugfix
- The inline calendar will no longer stay at the top of every screen.
- When you edited a worklog and made an invalid save action, the plugin changed to "Add worklog" mode, now it stays in "Edit".
Improvements
- The default JIRA snytax (2h 30m) is now supported in the duration field. ().
- Added global setting to set the first day of the week in the calendar. ().
- The fields now remember their values when changing date or when form submission fails. ().
- So far the issue picker only offered cached issues but now it searches between all of the issues.
- The worklog currently being edited is now highlighted in the worklog table.
- The plugin now remembers which one of the EndTime/Duration fields was filled in before an invalid submit.
- Removed radio buttons from End Time and Duration fields, now you can select between them by clicking into the appropriate field.
New features
- Copy button to the worklog table to quickly select recently used issues with a single the click of a button ().
- Copy function to the worklog table by clicking the appropriate cell.
- Chart report page to return a pie chart showing the logged work hours by projects in the given time interval.
Timetracker version 1.2.1
Bugfix
- Fixed unresolved constraint issue ().
- Fixed an issue where 31th days of months with work logs were not highlighted in the calendar.
Timetracker version 1.2.0
Bugfix
- The tabindex value of the duration time input field has been fixed.
- The information typed in the input fields will no longer get lost when refreshing the browser.
- In the worklog notes, the \r\n characters are handled appropriately.
- JIRA 6.x compatibility fixed.
Improvements
- Worklog table issue column shows the issue description when hovering the mouse pointer over the Issue Key.
- Calendar highlights function. (Other months, weekend and days with worklogs.)
- In the specified interval, Missing Days Report checks day by day the number of working hours logged on working days. (Configurable.)
New features
- Rounding function on “End Time” and “Start Time Now” buttons.
Timetracker version 1.1.0
Bugfix
- More aesthetic Summary layout.
Improvements
- Real Worklog Summary added to Summary.
- Calendar appearance. (popup, inline, both)
- Default Calendar date. (Actual day or the oldest blank day of the past week.)
- Development of the worklog table. (In case the estimated time is over, a notification icon appears next to the issues.)
- Ergonomic layout of the input fields.
- Use of tabulators between input fields made easier.
- When editing a worklog, it is possible to modify the date.
New features
- Edit All function added to Timetracker.
- The Missing Days report returns the days to which there are no worklogs assigned between two given dates.
- By the User Settings, the appearance of the plugin can be customized. (e.g.: Calendar appearance, Calendar default date selection)
- By the Global Settings, administrators can configure the plugin. (e.g.: Non-working issue, Non-estimated issue, Exclude date, Include date)
- Daily notification email sending. (Based on the worklogs created on a specific day and on the remaining estimated time)
Timetracker version 1.0.0
