Generate Reports

The Reports topic provides access to a number of on-screen reports and also to Javadoc documentation for source code.

Time and Progress Reports

You can generate and export a report on developer progress and time spent. In order to get useful data, your process should have developers estimating Work Item time. See Estimate Work Item Time and Report Time on Individual Work Items.

The process involves creating a query that isolates the Work Items you want to know about, and then exporting data to an Excel sheet using a specially-designed report template. The next section details the procedures.

Build a query:

Which Work Items to include in the time and progress report is up to you. You should become familiar with querying for Work Items and using the Query Builder to get the subset of Work Items you want for the report. Run the query from the Table view.

An example of some query parameters might include unresolved items in Project having a Status of in-progress. You can optionally include some specific assignees.

Tip:

Don't forget that you can save any query as a Shortcut for quick reuse later on. See Using Queries and Shortcuts.

Generate and export:

Once you have a query that isolates Work Items for the report, you can generate and export the report.

  1. Make sure you are viewing Work Items in the Table view.

  2. Click the Actions in the toolbar, and choose Export in the drop-down list. The Export Work Items dialog box appears.

  3. In the Format list, choose xlsx: Microsoft Excel.

  4. In the Template list, choose Time Report.

  5. (Optional) Add columns to the list of Selected Columns to include in the generated report document.

  6. (Optional) Show advanced options and change any settings as desired.

  7. Click OK to generate and download the report. You are prompted for a storage location.

To review the generated report, open the downloaded report file in Microsoft Excel or other compatible application.

Review Baselines and Baseline Reports

It is possible to create Project Baselines in Polarion which mark a state of Work Items in a tracker (usually a requirements tracker) at some point in time. Later, managers and/or other team members can check the differences between baselines, or a baseline and the current state of Work Items, by generating and reviewing Baseline Comparison Reports. Baselines and reports are covered in Project Baselines.

Generate and review Work Reports

When your process involves project members using Polarion's time recording features when completing Work Items, it is then possible for managers and others to generate Work Reports which summarize all Work Records for a project or a user during a specified time period. For information about the time recording fields and Work records, see Reporting Time and Progress.

Note:

Work Reports are generated in Microsoft Excel format.

Generate a Work Report:

  1. Access the Project for which you want the report.

  2. Select the Work Items topic if you want to report on all Work Items, or create a query to isolate some subset of project Work Items.

  3. On the Table view's toolbar, click the Operations button, and choose Create Work Report. The Create Work Report dialog box appears.

  4. Enter a title for the report in the Title field.

  5. (Optional) Specify a file name for the report you are creating. If a report with the same file name already exists, it appears in the Work Reports section at the bottom of the dialog box. You must either give the report a different file name or check the Overwrite existing file option.

  6. Specify the period you want the report to cover. Specify Period Start for the beginning of the period and Period Finish as the ending of the period.

    You can designate the Start and End of the period in any of several ways:

    • As a specific calendar date. Choose the Date option and specify a date using the date picker provided.

    • As one of the dates configured for the Project, for example, Project Start. Choose the Project Date option, and select one of the listed project dates.

    • As one of the Time Points configured for the Project. Choose the Time Point option and select a Time Point.

  7. Specify the Scale you want shown in the report. For example, if you choose Week, Work Records are summarized by week within the specified report period.

  8. Specify the report grouping. You can group the report by any or all of the following:

    • Project Group

    • Project

    • Category

    • User

    • Work Item Type

    • Work Item

  9. If you want to limit the scope of the report to the Work Items currently shown in the Work Items table, check the Report only work from Work Items from current selection option. Clear the option to report on all Work Items in the project.

  10. Click Start to send a job to the Scheduler. You can check the progress of the job in the Monitor topic. The time required to generate the report depends on the number of Work Items reported on and the availability of system resources.

    When the report is generated, a link appears in the Work Reports section of the dialog box. The link text is the file name of the report. You can open or download the report file. The Work Reports section contains a Refresh button which updated the report from the most current Work Item data.

  11. If you want to preserve the report settings for future reuse, check Remember this configuration.

Nonworking time representation:

Nonworking time, as configured in Working Calendars, is represented in Work Reports.

  • Nonworking time is indicated by gray background. It is displayed only on rows representing users.

  • When the scale of the report is Day, cells representing nonworking days of a user have a gray background

  • When scale is Week or Month, cells representing a week or month, all days of which are nonworking, have gray background.

Automating Work Reports:

An administrator can configure Polarion to run work reports as a scheduled job. For more information, see Configure the Scheduler and Work Report Job Configuration.

CMMI Report

Polarion provides a simplified CMMI compliance report based on the CMMI 1.1 Staged Presentation Level 2 (http://www.sei.cmu.edu/cmmi ). At this stage, it is not advisable to use this report as input for CMMI certifications. The CMMI report is a collection of pointers on how particular practices are implemented. It can be useful during preparation of a CMMI appraisal, as the report makes it easy to gather the data and provide references to established practices.

The report should be used as guideline rather than required rules. A CMMI report that says 0% is implemented means only that Polarion did not recognize artifacts in the way Polarion defines them. So, for example, a CMMI report might say there is zero Requirements Management because Polarion found no Work Items of type Requirement in the project against which the CMMI report was run. However, you might define and manage requirements in a separate project.

Access and run the CMMI Report:

The CMMI report is calculated for the current project, so you need to open the project for which you want to see the CMMI report. Open the desired project in the Open Project or Project Group dialog box. See Access Projects.

To run the report, expand the Quality topic in the Navigation pane and select CMMI. The report is generated on demand and displays in the Content Pane.

Report Structure:

The generated CMMI report has the following structure:

Key Process Areas + Percentage of Completion
     Specific/Generic Goal + Percentage of Completion
          Practices + Implementation Rating

Implementation Rating codes are as follows:

  • FI: Fully Implemented

  • LI: Largely Implemented

  • PI: Partially Implemented

  • NI: Not Implemented

  • N/A: Not rated