Document toolboxDocument toolbox

Global settings

Owned by Attila Bordás
Last updated: Apr 27, 2020 by Tibor Tasi
5 min read

On these pages you can configure the behaviour of the Timetracker.

Only JIRA Administrators, JIRA System Administrators can configure Timetracker. 

To open the Timetracker Global Settings: 

  1. Choose  > Add-ons. 
  2. Locate TIMETRACKER section and select the Global Settings field.




General



Mandatory Work Log Description

Adminstrators can choose whether worklog description is mandatory or not for Timetracker users. By default, description is optional.




Prohibit Overlapping Worklog

Enable this option if you want to prohibit users to add worklog if it's overlaps with another work log on Timetracker.




Worklog duration beyond midnight

By default, Timetracker does not support worklog that has its end time after midnight to keep the worklog reports accurate. This means, that duration value cannot exceed the value of 24:00 minus Start Time value.

You can enable this behaviour here, and using the Duration field the Timetracker will work in the same way as the JIRA time tracking. In this case, the working time, which lasts for the next day, will be counted to the day when it has started in the reports.




Timetracker Gadgets

You can enable or disable displaying the Timetracker Gadgets on Dashboards. By default, this option is enabled.




Results on Reporting pageload

You can enable or disable displaying the results of the previous (or the defualt) query on Reporting pageload.

By deafult, every reporting page load queried the results based on the previously selected critera for the current user. This option let's the administrators turn this behavior off and prevent queries on pageload. We recommend for our customers with large instances to turn this off when they experiencing problems on pageload.


Time Zone

You can choose how to show dates and times for users in the Timetracker:

  • System setting: By default the plugin uses the JIRA system time zone to show and to store dates.
  • User profile setting: By using the User profile setting the dates will be shown in the user's time zone throughout the plugin.

(warning) If the user's settings differ from the system time zone then dates may differ. (The date storage in the system still will be based on the system time zone.)


Display Timetracker section

You can enable or disable displaying the Timetracker section on Issue view. Totals and details of other users' worklogs logged to the issue are displayed on the Issue screen for the selected month. By default, this option is enabled.


Special Issues


Non-working issues

This feature is designed to manage non-working, non-billable issues, to provide credible reports. This feature can be useful if you have a dedicated project or issues for non-work activities, eg. for lunch.


Configration

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. 

Example

  • Use issue keys, eg. MYPROJECT-1, MYPROJECT-2
  • To set up all the issues of MYPROJECT to be Non-working, the following regular expression needs to be used: “MYPROJECT-.*”





Email notification about Non-estimated issues

This feature is designed to keep the remaining times up to date.

You can choose whether to send an email every day about issues where work was logged but there is no remaining time and are not in "Done" workflow status category. The notification email is delivered to the issue reporter and project lead, who have the "Permission to use the Plugin" permission.

Configration

You can configure the set of issues about which you want to receive mail:

  • All: Send email about each issue in JIRA. 
  • None: Ignore all of the Projects/Issues and don't send any email.
  • Selected: You can select certain Issues by writing issue keys or setting up 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-.*”)

You can choose when you want to receive these notification emails:

  1. Click on the input field.
    1. The field will be disabled, if you selected the "None" option
  2. Add your preferred time.

(warning) Sending email will be done on the basis of server time. The service will not take into account the user time zone.





Working days


Timetracker's many features behavior depends on whether the given day is a working day or not. (warning) By default, all weekdays are working days while all weekends are non-working days.

Normally, all users have to fill at least as many working time (hours) for each working day as is set in the "Time Tracking" settings. In case a user did not work as many time as expected, they can use the configured non-working issues to fill the day.

  • If there is no worklog for a day it will be shown in the "Missing days" tab of the plugin. 
  • The "Default date" of the "Calendar Appearance" is also calculated and colorized based on the working days.


Exclude date

You can add days that are weekdays but not working-days (For example: public national holidays):

  1. Click on the input field on the right side, or on the calendar icon.
  2. Write or select the desired date.
  3. Click on the "Add" button.
  4. If the date and it's format is valid, it will be added to the list of dates on the left.

You can remove the dates by clicking on the X on the label.

Include date

You can add days that are weekends, but working days:

  1. Click on the input field on the right side, or on the calendar icon.
  2. Write or select the desired date.
  3. Click on the "Add" button.
  4. If the date and it's format is valid, it will be added to the list of dates on the left.

You can remove the dates by clicking on the X on the label.




Loggable Periods


Here you can enable this restriction and configure the period in which the users can log work.

You can define the days (0-365) that users can log work in the past or in the future.

(info) To allow a user to log work only for the given day, enter zero in both fields.

In the Permission Settings you can add groups for which this is will be not valid and they will still be able to crate/edit worklog in the configured period.

This restriction can be useful after disabling the other Log Work options in Jira, otherwise it can be bypassed.



Analytics



Analytics removed

In the 3.12.0 version of Timetracker, we have removed the analytics tool from the add-on and this option is no longer visible.

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

The administrator can enable or disable the usage tracking.


Save or Reset configuration

  • Save: The settings can be saved by pressing the Save button. 
  • Reset: The Reset button can restore the foregoing settings. 
  • Cancel: By selecting the Cancel button, the user is redirected to the Administrator screen without making any changes.