Setting up a report

To set up a report, you select the things you want to measure, and choose an output format.

Follow these steps to define a report:

  1. On the Project Metrics page, choose how you will use this report.
    • If you want to use the report repeatedly, click Define report. This stores a copy of the query for later use.
    • If you just want to look at the date once, click Define instant report. This discards the query when you leave this page.
  2. In the Title field, give the report a name.

    To have the system assign a title for you, leave the Title field blank.

  3. In the Report type field, select the kind of report you want. You can select one of these types:
    • Trend report: See data as it changes over time.
    • Point in time report: See data as it exists at a single time.

    Click Next.

  4. Choose the project tool whose activity you want to measure. You can choose Project Tracker or Subversion.
  5. Choose the types of activity you want to measure. How you do this depends on the project tool you are interested in.

    If you are measuring Project Tracker activity, follow these steps:

    1. In the Artifact types field, select the kinds of artifacts you want to report on, and click Update.

      Note: If you select multiple artifact types, attributes that appear in all those artifact types are available for reporting on, if they have the same display name in all the artifact types.

    2. In the State attribute filter field, select a status attribute to filter by status attribute options.
    3. In the Attribute filter field, select an additional filter from the dropdown list and click the Update button.

      Select one or more of the resulting values, and click Next.

    4. Arrange the attributes in a way that will help the viewer make sense of the data. How you do this depends on the kind of report you are creating.
      • For a trend report: In the Time frame field, select the units of time over which you want to see data. You can view trends day by day, week by week, or some other way.
      • For a point in time report: In the Primary grouping and Sub grouping fields, group the data in a way that makes sense.

        Note: The primary grouping and sub grouping attributes cannot be the same.

      • For a point in time report: In the Chart format field, choose side-by-side or stacked layout for any vertical bars that appear in your report results.

    If this is a Subversion report, follow these steps:

    1. In the Activities field, choose one or more types of activity to measure:
      • For a domain activity report or an active users report, you can measure checkouts, updates, commits and general Subversion operations.
      • For a web-based report, you can measure only file downloads.
  6. Format your report. How you do this depends on the type of report you want:
    • If trend, choose the period of time over which you want to measure activity.
    • If point in time, choose the date for which you want to measure activity. You can select a date after the last data harvest or a date within the last three months in the case of Subversion.
  7. Click View report.

    The report appears on the Metrics report page, with tabs to select between table and chart views.

  8. On the Metrics report page, click Store this report to save the report.

Note: You can modify your report from the Metrics report page. To regenerate the report, click the Edit report button and reconfigure the parameters.