Chapter 8: Report Generation

<< Previous Chapter | Table of Contents | Next Chapter >>

Search Result Report

You can generate reports which capture the result of the following searches. To generate a search result report, perform your search and then choose the Tools | Generate Report command, or press the Generate Report button in the toolbar. The following dialog appears (for a project search report).

The Report File Name contains the name of the report file to be generated. You can change this.

The Report drop-down list contains a list of available report templates you can choose from. You can customize the currently-selected report template by pressing the Report button. You can also customize the page header/footer for a report by pressing the Header/Footer button.

The Options tab provides a list of options applicable to the currently-selected report template. To enable/disable an option, click in the tick column to toggle it.

The Filters tab is enabled only for certain reports, and allows you to filter the report data.

Press the Generate button to generate the report. The report is generated as an RTF document and immediately opened with your RTF viewer (usually Microsoft Word).


Object Report

You can generate reports which capture the contents of the following POMS objects. To generate an object report, drill down the object and then choose the Tools | Generate Report command, or press the Generate Report button in the toolbar. The following dialog appears (for a project report).

Make your choices from the dialog and press Generate to generate the report.

The Filters tab is enabled only for reports that provide filtering functionality. Project Review is one such report.

This report includes issues and risks. The filters allow you to decide which issues/risks should be included/excluded based on the selected criteria.


Report Template Customization

Each POMS report has an underlying template that determines what information the report contains and how it is formatted. You can customize a report template to create variations of it to suit your requirements. Customization does not affect the standard report templates provided by the product, but rather creates new ones.

To customize a report template, bring up the report generation dialog, choose the report you wish to customize from the Report drop-down list, and press the Report button. The following dialog will appear.

Report templates are classified into three kinds:

The above dialog illustrates this for the Project List report template. Project List is a standard template, Project List A is a shared template, and Project List B is a custom template.

To be able to create/access shared reports, you must nominate a shared directory where shared report templates reside. To do this, press the Shared Directory button, and navigate to and select a directory accessible by multiple users (e.g., on a network drive). The directory name will appear in the field to the right of the button. You can also clear this field by pressing the Clear button.

When you view the report customization dialog for the first time, it will only contain standard report template(s). To customize a template, select it in the list and press the Duplicate button. The following dialog will appear.

The Existing Name field depicts the name of the template you're duplicating, and the Duplicate As field depicts the name of the duplicated template. The Duplicate As Shared check box gives you the option of creating the template either as shared or as private (the check box is disabled if you haven't specified a shared directory yet). Enter the desired template name and press the OK button. The duplicate is created and immediately opened in your RTF editor, ready for editing.

To edit a shared or custom template, select it from the list and press the Edit button, or simply double-click its row. The template is opened, ready for editing.

To rename a shared or custom template, select it from the list and press the Rename button. The following dialog will appear, allowing you to rename the template.

To delete a shared or custom template, select it from the list and press the Delete button. You will be asked to confirm this operation.

The New button is reserved for future use and is, therefore, disabled at all times.

While editing a report template, you can modify two things:


Header/Footer Customization

If you want to change the header/footer of a report (to, for example, insert your company logo) then you don't need to customize the report template. The report generation dialog allows you to nominate a header/footer template to achieve this. When your report is generated, POMS takes the header/footer from your nominated header/footer template and applies it to the generated report, thus replacing the report's header/footer with that of the template.

The procedure for customizing header/footer templates is the same as that for customizing report templates. Press the Header/Footer button in the report generation dialog, and follow the customization procedure.

Template Directory Structure

Note: This section is provided for technical users. Normal users do not require any knowledge of this directory.

Custom report templates (along with standard templates auto-downloaded from the server) are stored on the client-side in the following directory:

<root>/prag/po/report/plate/
Where <root> represents the client-side root directory for your POMS installation.

For each report type, a sub-directory named after the report template exists within the above directory, which in turn contains two sub-directories, one for standard templates, and one for custom templates. For example, for Project List and Project List B, the locations of the template files are:

<root>/prag/po/report/plate/ProjectList/standard/Project List.rtf <root>/prag/po/report/plate/ProjectList/custom/Project List B.rtf

Shared report templates are held in your nominated shared directory under a sub-directory named after the report template. For example, the location of Project List A is:

<shared>/ProjectList/Project List A.rtf
Where <shared> represents your nominated shared directory.


Embedded Coding

In each POMS report template, you'll find two things:

Coding Syntax

All embedded code must conform to a simple LISP-like syntax. View some of the standard report templates to get a feel of the syntax. Be very careful when you edit embedded code in a report template. Syntax violations will result in the report template not compiling successfully. The most common syntax error is imbalanced parenthesis.

Within each report template, the variable repData is predefined. All report data is passed by POMS to the report engine via this variable. This variable is a nested structure, containing two sub-structures:

Calendar Fields

For a calendar report, repData.bo has the following fields.

Timesheet Fields

For a timesheet report, repData.bo has the following fields.

Project Fields

For a project search report, repData.bo is a vector of project summary structures, where each summary has the following fields. For a project report, repData.bo is a structure of the above fields and has a sub-structure called detail, which has the following additional fields:

Test Case Fields

For a test case search report, repData.bo is a vector of summary structures, where each summary has the following fields. For a test case report, repData.bo is a structure of the above fields and the following additional fields:

Issue/Risk Fields

For an issue/risk search report, repData.bo is a vector of summary structures, where each summary has the following fields. For an issue/risk report, repData.bo is a structure of the above fields and the following additional fields:


<< Previous Chapter | Table of Contents | Next Chapter >>

Copyright 2005 PragSoft Corporation (www.pragsoft.com)