Building reports

To avoid errors when build reports using the Report Builder, you must perform the steps in the order shown.

Procedure

  1. Plan the report.

    Based on the CR process you are using, determine whether you are reporting on CRs, tasks, or objects. Then, decide which attributes to select for the report. Also, decide which, if any, values you want calculated for you. Define the specific information you want in the report to define the components of the report.

    For example, you must determine if you need a subreport or a relation report. Subreports and relation reports are similar. Using both types of reports, you can look up an item related to the context item. For instance, if the context item is a CR, you might want to look up its associated tasks.

    Subreports and relation reports differ in several ways:
    • Defining a relation report is like defining a top-level report, except the report does not have a separate query or a main template. A subreport, however, has its own query that references the context item. It is actually a separate report that was previously defined. It is included inside another report.
    • Relation reports can be chained together in a linear fashion. That is, each item can show a single type of related item. That is, a single relationship versus a multiple type of related items (multiple relationships). Subreports enable reporting on multiple related items, which is done by including multiple subreports for the context item.

      So, if you wanted to show a CR and its tasks, both relation reports and subreports can do the job. However, to show a CR with its tasks and attachments, use a subreport. The relation report can show only one or the other (the tasks or the attachments, but not both).

  2. Start a Rational® Change session.
  3. Install a process package, if you have not done so already.

    A process package contains the list of reportable attributes for a CR process. Unless you install one of these packages, your attribute list is empty.

  4. On the Action Panel, click Report Builder.

    The Report Builder dialog box opens, with the Select Report File subdialog box is displayed.

  5. Select a report name, or create a report by typing a new report name.

    To change an existing report, click a report name in the Available Report Files list, and then click Edit.

    To define a new report, type a new report name in New Report File (including the xml file name extension), and then click Create.

    If you do not type a file name, Rational Change creates a report named csReportX.xml. The X is a number incremented whenever Rational Change creates a report using an existing report name.

  6. Define the query that generates the selection set of CRs, tasks, or objects on which you are reporting.
  7. Define general report properties.

    The report name you type is displayed for users in the System report and format lists.

  8. Select templates to include on the report.
  9. Define headers, the information that is displayed at the top of the report page.
  10. Define report bodies, the information that is displayed in the report body.
  11. Define footers, the information that is displayed at the bottom of the report page.
  12. Add charts to reports that is displayed at the bottom of the report.
  13. Define attribute grouping.

    Groupings create sections on the report based on an attribute value. You can also define a graphic for each grouping.

  14. Define sorting.

    Sorting determines the order that the items display in the report.

    Sorting is always applied after grouping. The attribute selected for grouping never displays in the sorting lists.

  15. Optionally, build relation reports.

    If your selection set contains items that have associated items (such as CRs with associated tasks), define a relation report that shows the associated items.

  16. Install reports.

    For detailed examples, see Report Builder examples.


Feedback