Viewing project metrics

The Metrics and Reporting page enables you to view Excel reports on active and historical work items in a project such as requirements. For example, you can view a graphical report that shows how many requirements are still in definition, how many are being designed, how many are in coding, and so on.

On this page, the queries for active requirements, defects, and so on return items with a Status attribute value of Submitted, Started, On hold, or Reopened, and historical work items have a Status attribute of Closed or Will Not Complete.

From the Metrics and Reporting page, you can do the following:

You can only open the Excel reports on a Windows operating system that has a recent version of Excel installed.

Note: The Excel reports generated from the Metrics and Reporting page can only work if basic authentication is enabled. These reports do not work on sites that use certificate-based authentication. Check with your domain administrator if you are not sure what type of authentication your site uses.

Downloading project metrics

This section describes how to download reports that contain project metrics.

To set up Excel for viewing the project metrics:

  1. Open Excel.
  2. Click Tools > Options > Security > Macro Security.
  3. Choose Medium or Low in the dialog.
  4. Click OK to close the Options dialog.
  5. Restart Excel.
  6. After restarting Excel, if you selected a Medium level of security, click Enable macros in the dialog that appears when you open a file.

To download Excel reports that contain project metrics:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Metrics and Reporting page in the Page Navigation toolbar or the Metrics and Reporting link in the left navigation pane.
  4. In the activity area, click the link for the appropriate search.
    The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background:
    All active <artifact type> - Download an Excel report for work items (requirements, action items, and so on) that have a Status attribute value of Submitted, Started, On hold, or Reopened.
    All historical <artifact type> - Download an Excel report for all work items (requirements, action items, and so on).
  5. In the File Download dialog, select Open.
  6. Extract the compressed file.
  7. When Excel opens, if your security setting is Medium, select the option to enable macros.
  8. Click the Configuration worksheet.
  9. If the Configuration worksheet does not display the correct URL for your project, input the URL for your project in the Target Project URL field, and press Enter.
  10. Click Test Report Generation.
  11. Accept the SSL certificate if prompted, and enter the username and password that you use to access CollabNet.
    The report displays graphical data of all work items of the selected type.

To permanently modify the project URL in the report file:

  1. Save the modified report with the correct URL to the Metrics and Reporting directory for the project.
    For example, you can go to the following location:
    Project/trunk/www/process-template/Metrics and Reporting/file-name
    Where Project is the name of the project, Project is the name of the project template selected for the project, and file-name is the name of the report.
  2. Commit your changes.

Troubleshooting a report

If you receive an error when you attempt to generate a report, check for the following:

Reading metrics documentation and downloading templates

You can access project documentation from a Documentation table on the Metrics and Reporting page. If an administrator has made them available, you can download templates for these documents from this page and upload draft or final documents. If you have created a new document template, you or the project owner can add it to the list of templates.

If you have a content developer role in the project (or have both VersionControl - Commit and VersionControl - Add permissions granted by an administrator), you can also add information to this page as well as view this page. However, the project administrator may prefer to take requests for additions to this page and be the sole person who actually performs the updates.

The documentation table on this page contains a View other project documents link. Clicking this link is equivalent to clicking the Documents and files link in the left navigation pane.

Important: If you experience any difficulty uploading documents on this page, ask your project administrator to be sure that two Subversion integrations settings are turned off for the project. The administrator should click the project link on the Projects page, clickEdit project > Tool configuration, then turn off the Message must name artifact and Committer must own artifact settings in the Subversion section of the page.

To view project documentation on the Metrics and Reporting page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click Metrics and Reporting on the page navigation toolbar or the left navigation pane.
  4. Scroll to the Process Documents table.
  5. Click the link for the document that you want to read.

To download a project document template from the Metrics and Reporting page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click Metrics and Reporting on the page navigation toolbar or the left navigation pane.
  4. In the Process Documents section, click the View document templates link.
  5. Click the link for the template that you want to edit.
  6. Save this file locally and edit it.

To add or update a project document on the Metrics and Reporting page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click Metrics and Reporting on the page navigation toolbar or the left navigation pane.
  4. In the Process Documents section, click the Upload document link.
  5. Browse to the document that you want to upload.
  6. Click Save.
    Note that this document is saved in the project's version control repository. If you want to rename or delete this document, you must use your version control client.