Adding a report template

You can add a report template to a Jazz project area, making it available for others to create new reports based on the template.
  1. In the Team Artifacts view, expand the Reports node under your Project Area.
  2. Right-click Report Templates and click New > Report Template.

    Add a new report template in the Team Artifacts view

  3. Specify a name and description for the report template.
  4. In the Identifier field, specify the ID for the report template.
    Tip: How are identifiers used?
    When adding a new report template in the Team Artifacts view, or defining one in a process template, there is an Identifer field. In certain cases, where reports are referenced by other artifacts, the report template identifier is important. For example:
    • In the dashboard, the Trend Report viewlets search for reports with particular identifiers. If they are found, the dashboard viewlet appears and is usable.
    • In the Iteration Plan editor, the Charts tab looks first for a report template with the identifier apt.WorkItems. If that is not found it will use workitems.OpenWorkItemsByType.
    • The dashboard viewlets offer drill-in support from the viewlet to a full-scale report. These references are by ID.
    • Occasionally, a report provides drill-in from one report to another (from Work Items by Team Area to Work Items by Owner, and also from Build Health to Build Result). These references are by ID.

    If you are just deploying a report for standalone use (no dashboard or other report is referencing it), you can use whatever ID you want, or none at all.

  5. Select the project or team area to associate the new report template with. All users will still be able to see the report template.
  6. Click Browse to find the BIRT report design file (.rptdesign). Several examples are included with the client in com.ibm.team.examples.reports.common.
  7. In the Resources area, click Add to select resources to include with the template. Resources must be supported by BIRT. They can be property files, design libraries, css files, etc., and they are identified by keys. When adding a resource to the report template, add the key and the file that contains the resource contents.
  8. Click OK. The report template is added to the project area.
What to do next
Now, you can create a report based on this report template.

Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug