Worklog History Viewer is a special tool for creating high customizable views - to analyze all data regarding logged work in given project on one screen. Using different types of views and many available operations, it is convenient to get needed data in many sets.
In order to start your work with the tool, you have to choose Worklog History from top menu:
After choosing "Create Worklog Viewer", you will get below view:
At default you will get data for your current project and current month.
Please note that only one project can be visible on the viewer at the same time. Also, if in your current project no issues were created or modified in current month, "No data found" comment will appear.
At the top of the screen you can find below details:
- "New Worklog History" - name of your viewer, set like this at default
- "Save as" button - where you can change default name and save your viewer after configuration:
During saving, all elements - name, configuration, visibility, selected column and row fields with filters, type and operations - are being saved. After opening saved viewer, all saved elements are being displayed and current data are being uploaded.
- "Refresh" button - where you can upload the most up-to-date information from your project
- "Public" button - where you can set visibility of your viewer on "Public" (seen by everyone) or "Private" (seen only by you). Please note that after you choose filter in "Configuration", you can set your viewer only "Private".
- "Configuration" button - where you can change project and date ranges on "Range" tab, time format used in the viewer on "General" tab and use filter on "Filter" tab.
If you use "Filter" tab, please remember that you can use only your private filters (you can find them on "Search" screen, named "Favourite filters" on the left menu). Also, if you choose filter, project and all dates chosen on first "Range" tab, won't be used for current viewer. Last but not least, after choosing filter for your viewer, you can save it only as "Private".
Please also note that setting made in Jira Administration -> Add-ons -> Status History Plugin -> General -> Date and time presentation affects on date display on the viewer.
- information about project and range of data used for this viewer.
After you configure range of data you want to analyze, you can adjust the viewer to your needs. For a start, every viewer has default set of types, fields and operations, as per below:
If you want to choose the view of your data, you have to click on Type:
Display format of hours depends on what you have set on Configuration. Please take a look at below example:
After you configure type and configuration of your viewer, you can set what fields you want to analyze.
At default, you start with one field for columns and two for rows, as per below example:
As you can see, in columns space there is "Users" field, and in rows space there are "Project" and "Issue" fields.
In below table, you will find all available fields with their description:
|Assignee||User assigned to the issue|
|Date Day||Day extracted from date of logged work start, eg. 11|
|Date Day Name||Shortened name of the day extracted from the date of logged work start, eg. Tue|
|Date Full||Full date of logged work start, in format set in Jira Administration -> Add-ons -> Status History Plugin -> General -> Date and time presentation, eg. 2017-08-17 11:00|
|Date Month||Shortened name of the month extracted from the date of logged work start, eg. Jan|
|Date Year||Year extracted from the date of logged work start, eg. 2017|
|Issue||Issue key, eg. MARIO-1|
|Issue Type||Issue type, eg. Task|
|Priority||Priority of the issue, eg. Medium|
|Project||Project key, eg. AS|
|Resolved||Resolution status, eg. Done|
|Status||Status of the issue, eg. To Do|
|Summary||Summary of the issue, eg. Login screen|
To add another fields to columns or rows, you simply drag and drop them in chosen space, as per below example:
You can change order of colums or rows, just by draging and dropping them in desired sequence in the space. If you don't want to have given field on columns or rows, simply drag and drop it back to "Fields" space.
After you choose desired combination of columns and rows, you can filter their values according to your needs - to do this, just click on icon on given field, like on picture below:
You can select or deselect all values, using buttons, or just deselect value from the list by clicking on it. Please note that selected values are with grey background.
Please note that if you have more than 400 values of given field, you won't see them in this pop-up screen - you will get relevant information instead.
You can also type desired value in text field, as per below:
After selecting needed values, you can click on icon to close this pop-up screen, or you can leave it open - and drag it to desired position on the screen, using icon (click on it, drag and drop in the place you want it to be displayed).
Please take a look at below example - only three values are selectes from "Issue" field, and pop-up is moved on the middle of the table:
Please also note that "Issue" field is now marked with * and written in italics, in order not to forget that filtering was set on this field.
After adjusting filtering to your needs, you can start analyzing your newly build viewer! Please take a look at below example:
You can analyze how many hours were logged on particular issues and by which users.
If you want to export your analyzed data to external file, you can do it using a link "CSV" placed above table. After clicking it, CSV file will be created. File will contain raw data, eg. times will be given in seconds - in order to further data processing.
Please remember about using "Refresh" button, to make sure that you analyze only up-to-date information. Saving your viewer will only remember all settings you've made - all data are uploaded at the time of opening the viewer.
After you save created viewer, you can use it anytime, simply by clicking "Worklog Viewer Manager" from top menu:
Logged user can modify or delete his/her own or public viewers - just remember that if you change public viewer to private, only the owner of the viewer will be able to see it.
Jira administrators are able to modify or delete all viewers, regardless of the owner.
You can filter the list, by putting letters in given field, as per below:
You can also sort the list, clicking on given column (asceding or descending) - on below example list is sorted by "Created" column, descending:
Using options below table, you can move between pages (Previous/Next) or choose how many rows you want to see on one screen (5, 10, 20, 25, 50 or 100).
Last but not least, some important things to remember:
Permission configuration has impact on visibility of viewer menu - if you set permission for specific groups or users, only these specific groups or users will see Worklog History in top menu and will be able to use the viewer. More details about this configuration you can find here.
Please remember that using this viewer you will get more flexibility in analyzing your project data, but also you have to be aware what outcomes you want to receive. We advice to correlate viewer results with data on issues.