Skip to end of metadata
Go to start of metadata

Installation of the add-on

  1. Connect to the JIRA server you want to install the Timesheets add-on as a user with administratory rights.
  2. Choose , then Add-ons.
  3. In the "Find new Add-ons" window, search for "Onlio Timesheets". Press Enter.
  4. Choose "Free Trial" for the add-on "Onlio Timesheets".
  5. Sign in with your AtlassianID to obtain an evaluation license.

The Timesheets installation procedure includes:

  • Installation of mandatory files.
  • Creating default JIRA groups for Timesheets
  • Assignment of the administrators to the timesheets-administrators group
  • Basic setup for the add-on and the JIRA database.

The administrator is notified about regular FarAway updates on the Atlassian marketplace through the JIRA Universal Plugin Manager.

License

After the trial version expires, you must buy a license. Without it, you cannot enter new data into the application or change any settings. You can use either an Onlio license, bought at Onlio, a.s., or an Atlassian license, bought at the Atlassian Marketplace. When using an Onlio license, the Atlassian license field (as shown below) must be empty.

Administration

To access the application's administration:

  1. Choose , then Add-ons.
  2. Choose one of the options at the "ONLIO TIMESHEETS" section.

Settings

The administrator can change the majority of the application's settings here.

 

SettingDescriptionJIRA Group name / default setting
Timesheets Administrators GroupUsers that can see and edit all worklogs and reportstimesheets-administrators
Timesheets Viewers GroupUsers that can see all worklogstimesheets-viewers
Timesheets Viewers Project RoleProject role whose members can see all worklogs in a project 
Summary Entry LimitDefault limit for the number of worklogs in the "Worklog overview" menu in the JIRA issue500
Entry Update LimitMaximum number of entries that can be bulk changed5000
Disable ExportEnable / Disable exportingfalse
Worktime estimate custom fieldName of the custom field used to calculate the "Worktime estimate" value 
Activity custom fieldName of custom field for the "Activity" attribute. This one defines the default activity for the issue and is named after the custom field "Timesheets: Activity"; see Custom field chapter 
Entry into pastNumber of days in which work can be logged retroactively3
Entry into future

Number of days in which work can be logged into the future

3
Timesheets Exceptions groupUsers that can give exceptions to other users to log work over the prescribed limit abovetimesheets-exceptions
Exception - number of hoursDuration of the exception period given to a user to log work over the prescribed limit2
Exception - number of daysNumber of days in which a user granted an exception can log work retroactively14

 

Public Holidays

Enter public holidays here. They will have a different color in the add-on's calendar. The format to add the entries in is DD.MM.RRRR with every date on a separate line.

 

Organisational structure

Users added here can log work into Timesheets. The users must already exist in JIRA and can be added by the "Add Employee" button. You can set the employee relationships here (superior, deputy, etc.) and this data is stored in internal database.

 

Adding a new user

SettingDescription
EmployeeAn employee must be an existing JIRA user
WorkloadThe entered employee's workload size on a scale of 0.01 to 1.00 (1.0 = 100% workload)
Valid fromStart date of the entered employee's work period
Valid toEnd date of the entered employee's work period
SuperiorThe entered employee's superior
DeputyThe entered employee's deputy
DepartmentThe entered employee's department - relevant when assigning activities to departments

Team

The entered employee's team
RoleThe entered employee's role
PositionThe entered employee's team position

Global lists

The "activity" dial is used to choose a type of work when logging time.

  • Name - Activity name
  • Enabled for Departments - Departments able to log this activity. Department names are separated by a space; if the activity can be logged by all departments, keep this field empty.
  • Description - Activity description
  • Enabled - Enable or disable entering of activity

Project settings

To log time on issues in a project, we need to enable the addon in the project's settings first.

Along with other options:

 

SettingDescription
Timesheets projectEnables/disables the Timesheets panel for this project
General Timesheets issues projectEnables the displaying of issues in this project in the quick entry drop-down menu when viewing a timesheet.
Allow logging workAllows the logging of work on issues in this project
Allow logging work on Closed issuesAllows the logging of work on closed issues in this project
Status "Closed" for projectIssue status considered as closed in this project
Use activity attributeAllows the entry of "activity" into the custom field during the add-on configuration
Default project activityDefault contents of the "activity" custom field
Enable change default activityPermits users to change the default activity for a project or issue
Create issue commentIf a worklog on an issue has a comment, the same comment is created in the issue.
Comment viewableThe project role that can view worklog comments
Issue link typeIssue link connecting an issue to a superior issue

Visibility of timesheets for Project/Component Leads

Enables/disables timesheet visibility for the Project Lead and Component Lead

Bulk entry update

Users with the timesheets-administrator permission can edit several entries at once.

First, find the entries you want to change in the filter below.

SettingDescription
Date FromLowest time boundary of the worklog search
Date ToHighest time boundary of the worklog search
Issue KeyIssue key of the issue in which we are searching for worklogs
Issue IDIn case the issue had been moved, enter its ID.

 

After clicking "Search Entries" the add-on will search for the suitable worklogs. .


If the worklogs are found, the user can:

  • change special attributes (so far only the "activity" field)
  • change the attributes of the organisational structure (ex. department, role...)
  • change invoices (the "invoice" attribute, if included in an issue)
  • move the worklogs to another issue.

Exceptions

You can give an exception to an employee that needs to log work further in the past than he is allowed to by the "entry into past" limit. With this exception, he can log work for X days back for a period of Y hours.

SettingDescription
EmployeeEmployee that is to be granted the exception
Exception - number of daysNumber of days in the past the work be logged for
Exception - number of hoursLength of the period the user can log work in
EmployeeName of the employee with the exception
Created byName of the employee who granted the exception
FromStart date of the exception
ToEnd date of the exception
Count of daysNumber of days in the past the work be logged for
Hours numberLength of the period the user can log work in

 

Onlio license

On this screen, you can add a license key purchased in Onlio - but not the one bought on Atlassian Marketplace (that key can be added on the FarAway tab in "Manage add-ons"). If you want to use an Onlio-issued license, the field for the Atlassian license must be empty. You see either the "Aktuálně není k dispozici žádná licence" notice in case you don't use a Onlio license, or its description, if you do.

No license is used

A valid license screen


Custom fields

Timesheets use three custom fields.

  • Timesheets: Activity – This custom field displays the activity type for an issue.
  • Timesheets: Time Spent – This custom field displays the value sum of all work logged on an issue.
  • Timesheets: Work status – Shows the value of "Worktime estimate" and "Worklog Total". The displaying of this issue must first be enabled in the add-on settings.


Displaying each of the fields can be modified by security measures.


  • No labels