Add and edit 7pace Timetracker reports, add new widgets, export/import widget definitions, add columns to a widget table, change time granularity and troubleshoot common reporting errors
If you require additional assistance, training or are interested in having a custom report created for you, consider enlisting our professional services.
Contents
Tutorial: Reporting and Widgets
- Personal Overview
- Team Overview Report
- Team Overview Report (Date Period)
- Backlog Report
- Epics Report
- Last Tracks
- Line Chart
- Column / Bar Chart
- Pie / Donut Chart
- Number Chart
- Table
- Drilldown Table
- Stacked Bars
- Pivot table
- How to: Add a report
- How to: Edit a report
- How to: Delete a report
- How to: Reorder Widgets
- How to: Export data to Excel
- How to: Zoom in and zoom out on Widgets
- How to: Add new widget
- How to: Export/Import widget definitions
- How to: Add columns to Table widget
- How to: Change time granularity in Column chart widget
Troubleshooting and common issues
Default Reports
Please note that currently all reports are personal and cannot be shared with other team members within a project or organization at this time.
The Reporting page of 7pace Timetracker comes with the following default reports for your convenience. Depending on the report, you may have the option to change the date range of data that displays.
Personal Overview
This report shows an individual progress line chart, as well as a breakout of the days you worked, total time worked, average time worked per day, and time worked during the current day, during the selected time period. It also shows a time tracked per day bar chart, a details panel of the work items you tracked on, and projects and activity types pie charts for that period.
Team Overview Report
This report shows all time tracked by the team for the current day, current week, current month, and current year. It also shows a period summary line chart, a projects pie chart, team time per day bar chart, activity types line chart and pie chart, team time tracked per person breakout list, team time tracked per person pie chart, and top 30 work items tracked for the current month details panel.
Team Overview Report (Date Period)
For this report, you can select the time period of data you’d like to see. It shows a period summary line chart, a projects pie chart, team time per day bar chart, activity types line chart and pie chart, activity types line and pie charts, team time tracked per person breakout list, team time tracked per person pie chart, top 30 work items tracked for the selected time period details panel, and Iterations bar chart.
Backlog Report
For this report, you can select the time period of data you’d like to see. It includes a team work item details panel with their children, time tracked per Work Item Type, and time.
Epics Report
For this report, you can select the time period of data you’d like to see. It includes a team work item details panel, time tracked per person list, time tracked per project and per activity type pie charts, total tracked time for the selected period line chart, and daily time bar chart. Please note that this report features data from the work item and its children.
Last Tracks
This report shows time tracked on the current day and the previous day.
Report properties
Every report has several configurable properties:
- Name
- Prefilter - The option to limit data displayed on the report by current user or current project. These filters are dynamic and depend on the current user who opened the report or on the project.
- Type - The option to enable or disable the Date filter on the report.
Note: You can't change this option after a report has been created; you have to create a new report and copy the Widgets into it.
- Filters have two types: Work item filter and worklog filter. For technical reference, check this section.
- Projects - Work item filter that provides a list of projects that can be used to filter data on the report
- Area - Work item filter that provides the ability to filter by the area path of work items
- Iteration - Work item filter that provides the ability to filter by the iteration path of work items
- State - Work item filter that provides the ability to filter by work item state
- Work Item Type - Work item filter that provides the ability to filter by the type of work items
- Person - Worklog filter that provides the ability to filter by specific team members (Important: To see the Person filter, the user must have at least the "Product" role assigned. This filter is not available for "Team" role users. To check on your users' permissions, you can go to the "Settings" page of Timetracker -> User Management ).
- Activity Type - Worklog filter that provides the ability to filter by the Activity Type of worklogs
- Work Item Filters Type - These define how the filters, above, marked as work Item filters, are applied to work items:
- Apply on only top-level work items - filters are applied only to the work items that do not have parents (e.g. Epics) and are not applied on the children of those work items. This can be helpful with reports that have drill-down tables that present data for high-level work items.
- Apply on the whole hierarchy - filters are applied on all the items that are present in the backlog and only leave items matching the specific condition.
About privacy
By default, because reporting operates under Service Account permissions, users have access to all worklogs and work items within reporting. If privacy issues are a concern and you'd like to restrict access to only those projects to which your users currently have access, disable the "Allow access to DevOps data from restricted projects in Reporting" checkbox in Service Account Settings.
Widget types
Line Chart - Visually presents a series of data points over intervals of time as a linear graph. It is often used to show trend data.
Column / Bar Chart - Compares values by visualizing data as vertical bars with height being proportional to the values.
Pie / Donut Chart - Shows proportions and percentages between categories by dividing a circle into proportional segments.
Number Chart - Shows concrete values from a series of data and is often used to display a summary, average values or other results of data aggregation.
Table - Shows a detailed set of flat data.
Drilldown Table - Presents a detailed data set in which every entity can be expanded to display related information.
Stacked Bars - Compares data by categories, dividing each category into smaller pieces to compare each. Similar to a column chart, categories are displayed as vertical bars with height being proportional to the totals, and each bar divided into smaller rectangles to represent the values.
Pivot table - Is used to quickly summarize large amounts of data. You can use a PivotTable to analyze numerical data in detail, and answer unanticipated questions about your data. A PivotTable is especially designed for querying large amounts of data in many user-friendly ways. We have created a pivot table template which can be downloaded from the following link: Pivot table
Note: Pivot table is not available out of the box in the 7pace UI currently, but we have created a workaround that utilizes our API to achieve pivot table functionality.
Working with reports
How to: Add a report
1. From the Reporting page, select the default reports list dropdown and then click “New Report”.
2. Type in a report “Name”, select a “Pre-filter dashboard” (“None”, “Me” or “CurrentProject”), select “Type” (“Date Period” or “No Date Period”), check relevant “Enabled Filters”, and select “Work Item Filters Type” (“Apply on whole hierarchy” or “apply only on top level work items”).
3. Click “Save”.
“Create Widgets for your report” page displays.
Click here for how to add a widget.
How to: Edit a report
1. To edit an existing report, click on the “Edit” button.
The "Edit report" window displays.
2. Make changes to any of the fields within the window and click “Save”.
How to: Delete a report
1. To delete an existing report, click on the dropdown icon by the “Edit” button.
2. Select “Delete Report”.
3. On the “Are you sure” popup window, select “Yes”.
Report is deleted.
Important: For the time being, if you delete all default reports, you must delete any user-created reports to have the default reports return.
How to: Reorder Widgets
1. Click the dropdown arrow icon next to the “Edit” button and select “Reorder Widgets”.
2. With your mouse or keypad, move the Widget or Widgets to the preferred placement on the page.
3. Click on blue “Done Reorder” button at the top-center of the page.
New placement of Widget or Widgets is saved.
How to: Export data to Excel
1. With the report of your choice selected, hover your mouse over an individual Widget until the “Export Data” icon displays.
2. Click "Export Data".
Data from the Widget is exported to an Excel file.
Note: Only visible data will be exported. If you export data from tables, only the items that are present in the table will be exported.
How to: Zoom in and zoom out of Widgets
1. On the Widget of your choice, hover over it until dotted grid lines display on it.
You can then zoom in or zoom out to the level of detail you require.
How to: Add new Widget
1. Choose a report where you want to add a Widget.
2. Click the "Add Widget" button.
3. Choose the Widget type you need.
For this example, let's create a Drilldown Table.
4. When you click "Drilldown Table", you'll see the table configuration.
5. Fill in the title.
6. Add subtitle (optional). If you check the Auto title checkbox, it will be automatically filled by the widget pre-filter value.
7. Choose the Widget size.
8. Choose the OData endpoint where you need to pull data (all endpoints described here).
For this example, let's say we want to show all work items on which the team tracked time with all hierarchy levels.
9. Therefore, choose "workItemsHierarchyAllLevels".
You now need to construct an OData Query (for more information, see OData documentation):
In this case, we'll need this query:
$select=System_Id,System_WorkItemType,System_TeamProject,System_Title,TrackedTotal,TrackedItself,System_State,System_AssignedTo,HasChildren&$filter=TrackedTotal gt 0
The "children" endpoint and "children" query will be filled automatically.
The other settings should be filled in the Console field as JSON:
- Our table will have a hierarchy, so fill the field so our table can show this hierarchy.
"hierarchyField": "System_Id"
- The only one we need to now fill is the columns field:
"columns": [
{
"field": "System_Id",
"title": "ID",
"formatter": "WorkItemId",
"width": 60
},
{
"field": [
"System_Title",
"System_WorkItemType",
"System_TeamProject"
],
"title": "Title",
"formatter": "WorkItemIndicator",
"width": -100,
"expand": true
},
{
"field": "System_State",
"title": "State",
"width": 100
},
{
"field": "System_AreaPath",
"title": "Area",
"width": 100
},
{
"field": "System_AssignedTo",
"title": "Assigned To",
"width": 150
},
{
"field": "TrackedTotal",
"title": "Tracked",
"width": 100,
"formatter": "TimeLength"
},
{
"field": "Microsoft_VSTS_Scheduling_Effort",
"title": "Effort",
"width": 100,
"formatter": ""
}
]
Each field can be formatted using formatter.
The full Console input will look like this:
{
"hierarchyField": "System_Id",
"childrenQuery": "({hierarchyField})/Children?{query}",
"columns": [
{
"field": "System_Id",
"title": "ID",
"formatter": "WorkItemId",
"width": 60
},
{
"field": [
"System_Title",
"System_WorkItemType",
"System_TeamProject"
],
"title": "Title",
"formatter": "WorkItemIndicator",
"width": -100,
"expand": true
},
{
"field": "System_State",
"title": "State",
"width": 100
},
{
"field": "System_AreaPath",
"title": "Area",
"width": 100
},
{
"field": "System_AssignedTo",
"title": "Assigned To",
"width": 150
},
{
"field": "TrackedTotal",
"title": "Tracked",
"width": 100,
"formatter": "TimeLength"
},
{
"field": "Microsoft_VSTS_Scheduling_Effort",
"title": "Effort",
"width": 100,
"formatter": ""
}
],
"childrenEndpoint": "workItemsHierarchy"
}
10. Click the Save button.
11. Click Refresh.
How to: Export/Import Widget definitions
To export a Widget definition to share with anyone:
1. Choose the Widget you need to copy or share with someone.
2. Click "Settings" on the Widget.
3. Select "Export definition".
Copy, close and share that JSON definition with any user or import on one of your reports.
To import a Widget definition:
1. Click "Add Widget".
2. Select "Import now".
3. Insert Widget code.
4. Click "Import".
How to: Add columns to a Widget table
A common scenario is to modify a Widget table to display additional fields required by your team.
Example: Add additional columns: "Created Date" and "Billable Hours":
First, change the query to add the new fields:
$select=System_Id,System_CreatedDate,TrackedItselfBillable,System_WorkItemType,System_TeamProject,System_Title,TrackedTotal,TrackedItself,System_State,System_AssignedTo,HasChildren&$filter=TrackedTotal gt 0
Second, add new columns so the table can show the new fields:
{
"field": "System_CreatedDate",
"title": "Created Date",
"width": 100,
"formatter": "LocaleSettingsDateTime"
},
{
"field": "TrackedItselfBillable",
"title": "Billable hours",
"width": 100,
"formatter": "TimeLength"
}
System_CreatedDate column is added with the "Created Date" title and formatter LocaleSettingsDateTime that displays the date in a users preferred format.
How to: Change time granularity in Column chart Widget
Default reports come with several line/column charts that show time displayed over a specific period. All of them use "day" as the time granularity. If you are interested in using "month" instead, it can be accomplished with the following steps:
1. Click "Settings" on the Widget.
2. Click "Reconfigure".
3. Find xAxis definition:
"xAxis": {
"type": "date",
"title": "",
"rotation": 0,
"granularity": "day",
"minGridDistance": 50
},
4. Change "granularity" value to "month" and click Save.
Widget should now display data in month granularity.
Troubleshooting and common issues
Service Account is not configured for your organization
For Reporting to work, the Service Account must be configured. To do this, the Service Account page should be opened by a user from the Collection Admin group.
How to restart reporting
If you are experiencing issues with reporting, our support team recommends that you restart reporting. To do this, navigate to Settings -> Reporting & REST API and click the "Restart Reporting" button.
Comments
0 comments
Please sign in to leave a comment.