Web Reports User Guide for Release 6.2.0
This guide will help you understand the web reports feature of ScrumWorks Pro. The information contained within this guide is designed to give you in-depth knowledge of how this feature works so that you can use them to their full potential.
Quick Links
Web Reports
  • Overview
Web Report Editor
  • Adding a module
  • Editing a module
  • Removing a module
  • Saving your report
Web Report Modules
  • Product Backlog Items
  • Release Burndown by Sprint
  • Release Forecast Report
  • Current Task Data
  • Current Sprint Burndown
  • Team Impediments
  • Backlog Item Cycle And Lead Time
  • Velocity History
  • Release Burn-Up
  • Epic Progress Report

ScrumWorks Pro Desktop Client User Guide

Documentation Home

Web Reports

Overview

Web Reports allow users to create customized, read-only web pages that contain data and graphical report elements. The published reports are accessible by anyone who knows the unique URL of the report, without requiring authentication. Web Reports reflect real-time, up to date ScrumWorks Pro data; they always reflect the Product at the time they are viewed, instead of representing a static snapshot of the Product at the time the report was created. Web Reports can be bookmarked and accessed as needed for real-time reporting needs. Users can review and edit existing Web Reports through the 'Reports' > 'Web Reports' menu in ScrumWorks Pro.

Images within web reports can be referenced by its URL. Just embed these images into your own HTML pages to include up to date charts.

Keep in mind that saved web reports are linked to the user that created them, and may be modified by that user. If you remove that user for some reason the reports will also be removed from the system.

» top

Web Report Editor

Use the Web Report Editor to compile reporting modules for inclusion in a specified Web Report. Modules represent components of data to be included in each Web Report. User can combine modules to create unique reports and flexible layouts.
Adding a module

Required Permissions: Manage Web Reports

To add a module to your report, drag it from the list on the left and drop it into your desired location within the preview area on the right or select a module and click on the 'Add Module' button. The order of the modules within the preview area correspond to the order of the data within the web report. You can add multiple components of the same type to your report. To reposition a module, simply drag and drop it into a desired layout location.

» top

Editing a module

Required Permissions: Manage Web Reports

Double click the module's representation in the preview area on the right side of the screen or select the module in the preview area and click on the 'Edit Module' button. An editor specific to the module type will appear for you to customize the module. See the modules section for more information about each type.

» top

Removing a module

Required Permissions: Manage Web Reports

Select the module's representation in the preview area on the right side of the screen. Click the 'Delete Module' button near the bottom of the dialog. Confirm that you really want to delete the selected module.

» top

Saving your report

Required Permissions: Manage Web Reports

Reports require a name and at least one edited module. Provided both, the 'Save' button at the bottom of the dialog is enabled, allowing you to save the report. Once saved, the URL of the report will appear in the 'Web Report URL' field and the 'View in browser' button will be enabled. Copy the URL and distribute it as you like. Please keep in mind that Web Reports are unauthenticated, so be judicious in disseminating Web Report URLs.

You can only save the report when all modules within the preview area have been edited. Edited modules list the module details within the preview area. Uneditted modules are also indicated as such.

If you make changes to any modules, you will need to press the 'Save' button to save the updated report to the server and view the changes in the URL. The result will be immediately viewable.

» top

Web Report Modules

Product Backlog Items
When creating or modifying a Product Backlog Items module, the following attributes of the module can be selected on the configuration dialog:
  • Product Backlog Item Attributes: Determines which attributes of the published Product Backlog Items will be displayed on the report. In order to be able to select an attribute to display, the user must have the permission to view the attribute in the Backlog Planner. The title attribute is always displayed.
  • Optional Releases Filter: Select this filter to include only Product Backlog Items from specific Releases. By default, Product Backlog Items from all Releases are included in the report.
  • Optional Themes Filter: Select This filter to display or exclude only Product Backlog Items matching specific Theme criteria. By default, all Product Backlog Items - themed and unthemed - are included in the report.
  • Optional Status Filter: Select this filter to display only Product Backlog Items of specified statuses. By default, Product Backlog Items of all statuses are included in the report.
Every Backlog Item in the Product will be included unless a Release, Theme, or Status filter is enabled and selected.

» top

Release Burndown by Sprint

For a full description of the Release Burndown by Sprint, see the description in the Reports section of the user guide.

The bars in the chart include the backlog items in the selected releases. The preview on the right side of the screen displays the current data that will be published. If PBIs are added or removed from the selected releases, the published report will show the updated information.

Users must have permission to view reports to be able to publish this module.

» top

Release Forecast Report

For a full description of the Release Forecast Report, see the description in the Reports section of the user guide.

The bars in the chart include the backlog items in the selected releases. The preview on the right side of the screen displays the current data that will be published. If PBIs are added or removed from the selected releases, the published report will show the updated information.

If the trendlines intersect, you will be able to select "Forecast Completion". If the data changes later and the trendlines do not intersect within a reasonable amount of time, the report will not try to forecast the completion date.

When the option for Completion Forecasts is checked, any specified trendlines that will intersect in a reasonable amount of time with the Work Added/Removed Trendline will be extended to those points, and the chart will expand in scale to display the intersections. If no specified trendlines will intersect with the Work Added/Removed Trendline, no completion forecast is possible and will not be displayed. Note that as data changes over the duration of the report, a chart whose trendlines may have at one time offered a reasonable completion forecast may at other times offer no reasonable intersection, and thus these forecasts may appear and disappear even though a completion forecast remains specified for that report.

Users must have permission to view reports to be able to publish this module.

» top

Current Task Data
When creating or modifying a "Current Task Data" module, the following attributes of the module can be selected on the configuration dialog:
  • Task Attributes: This determines which attributes of the published Tasks will be displayed on the report. The PBI and Task Title attributes are always displayed.
  • Teams: This allows the user to select which teams' data will be shown in the report. You must select at least one team to save your changes.
Users must have permission to view tasks to be able to publish this report.

» top

Current Sprint Burndown

When creating or modifying a "Current Sprint Burndown" module, users can select which teams' data will be shown in the report. You must select at least one team to save your changes. Each burndown chart will be titled with the team name, sprint name, sprint start date, and sprint end date.

Users must have permission to view tasks to be able to publish this report.

» top

Team Impediments
When creating or modifying a Team Impediments module, the following attributes of the module can be selected in the specification dialog:
  • Teams: determines which Teams' Impediments will be displayed in the report. Select the radio button for "All active Teams" to include Impediments for all Teams that are actively working (in the current Sprint) on the Product at the time the report is accessed.

    Select the radio button for "Filter by Team" to select only those Teams whose Impediments you wish to appear in the report. When the Teams you select are active and assigned to the Product, only their (and not other Teams') Impediments will be displayed in the report.

  • Show/Hide resolved: Determines whether resolved Impediments for the selected Teams are included in the report. Check the box if you wish resolved Impediments to be displayed along with unresolved Impediments. Note that Impediments are listed chronologically by 'date entered', not by resolution status.

» top

Backlog Item Cycle And Lead Time
The bars in Backlog Item Cycle And Lead Time module represent the Cycle Time and Lead Time of backlog items in the selected product.
  • Cycle Time: The average number of days across all completed backlog items between the first time they were committed to a sprint or kanban team and the day they were marked done.
  • Lead Time: The average number of days across all completed backlog items between creation and the day they were marked done.
The following attributes of Backlog Item Cycle And Lead Time module can be selected on the configuration dialog:
  • Releases Filter: To include product backlog items from the selected releases only. At least one release should be selected to generate the report. "Check all" can be used to select all releases in the product.

» top

Velocity History

The Velocity History module shows the historic velocity of past sprints for a team in the currently selected product. The y-axis is in backlog effort while the x-axis is sprints. Each bar in the chart represents the velocity of the selected team for a given sprint.

A horizontal line on the chart shows the velocity average of all included sprints.

A linear trend line is also included to indicate the overall change in team velocity over all included sprints.

When creating or modifying a Velocity History module, the following attributes of the module can be selected on the configuration dialog:

  • Team: Select the team to see the velocity history of that team. Since the scope of each module is restricted to a single team, multiple teams can be show cased in a single web report by adding separate Velocity History modules for each desired team to the same web report.
  • Sprints: Choose to see all sprints or a subset of the most recent sprints. The Sprints displayed are restricted to the current Product context.

» top

Release Burn-Up

The Release Burn-up module shows the history of the total backlog effort for a release as compared to the total backlog effort completed. The y-axis represents backlog effort while the x-axis represents time in days. Linear trend lines give the average rate that both the total and done backlog efforts are changing.

When creating or modifying a Release Burn-Up module, the following attributes of the module can be selected on the configuration dialog:

  • Release: The release on which the report should be based.
  • Include Forecast: Will extend the report to show when the linear trend lines will intersect, if it is possible for the lines to intersect in the future.

» top

Epic Progress Report

For a full description of the Epic Progress Report, see the description in the Reports section of the user guide.

The bars in the chart include the progress of the backlog items in the selected epics. The preview on the right side of the screen displays the current data that will be published. If epics are added or removed from the selected release, the published report will show the updated information.

Users must have permission to view reports to be able to publish this module.

» top

Documentation Home | Web Client User Guide | Support and Training | ScrumWorks Desktop Client
Copyright © 2013 CollabNet, Inc. All rights reserved.