How to Create Project Reports

This task describes how to create project reports.

To learn more about project reports, see Project Reports Overview.

1. Create a project report

   1. Open the Analysis View module. On the ALM sidebar, under Dashboard, select Analysis View.

   2. Add a folder to the analysis tree. Right-click a folder under the Private or Public root folder, and select New Folder.

   3. Create a new project report. Right-click a folder, and select New Project Report. Fill in the New Project Report dialog box.

2. Define sections

   1. Select a project report. In the Analysis View module, select a project report, and click the Configuration tab.

   2. Add a section. Right-click the Document root node, and select Add Report Section. Select an ALM entity to include in the report.

   3. Add a sub-section. You can add a sub-section of related information. For example, add a sub-section of defects linked to requirements, or a sub-section of defect attachments.

   Each section can have multiple sub-sections and, where applicable, you can add further sub-sections to sub-sections.

   Right-click a section in the report tree, and select Add Report Section.

   Note: You can add sub-sections only to sections that are assigned a full-page template. For more details on full-page templates, refer to the Micro Focus Application Lifecycle Management Administrator Guide: Guidelines for Creating Full-Page and Tabular Templates.

3. Configure document-level settings

   At the Document root level, you assign templates and define settings that apply to the overall design and content of the project report.

   1. In the Configuration tab, select the Document root node. For user interface details, see Configuration Tab - Project Reports.

   2. Set the document output format.

   3. Assign document, style and history templates, or keep the default templates. For details on the template types, refer to the Micro Focus Application Lifecycle Management Administrator Guide: About Project Report Templates.

   4. Click Edit Document Field Values  to type values for custom fields in areas such as the title page, headers and footers, as defined in the document template.

   5. To create a baseline report, select Select a Baseline, and select a baseline.

      To create a baseline report, all report sections must support baselines.

   6. Select Embed Text and Image Attachments, to embed text and image attachments in the report.

      To display attachments, you must add attachment sub-sections to the report.

      Note: If you do not select this option, links to text and image attachments are inserted in the report, that open the files in a separate window. ALM opens the most up-to-date version of the attachments and if they have changed since the report was first generated, the information displayed may contradict other information contained in the report.

   7. Select Auto-Update Table of contents to instruct ALM to update table of contents entries in the report output.

      To display a table of contents, the document template must include a TOC field.

4. Configure sections

   1. In the Configuration tab, select a section or sub-section in the report tree. For user interface details, see Configuration Tab - Project Reports.

   2. Optionally, rename the section title.

   3. Assign a project template, or keep the default template.

   Note: Depending on your user group permissions, you can assign a custom template. For details on creating a custom template, see How to Create a Custom Report Template.

   4. Define a data filter, where applicable, to define the records that are included in the section.

   5. For top-level sections that include entities that are listed hierarchically (for example, requirements, tests), select whether records are ordered hierarchically in the report.

   6. Add existing graphs to the report, or create new graphs directly in the report.

5. Preview a template report

   Click Preview to display a preview of your report.

   A preview contains up to five records of each section in the report. The preview is displayed in the output format you selected for the Document root node.

6. Generate a template report

   Click Generate. The report generation process begins.

   When the report generation is complete, it is displayed in the output format you selected for the Document root node.

   The report is saved on the client machine, under the following directory:

   %Temp%\TD_80\<ALM_PATH>\<Project_id>\Reports

   Where <Project_id> is a string representing your ALM project.

7. Share a report outside ALM

   Allow ALM users or others to view read-only versions of reports outside ALM.

   1. In the analysis tree, right-click a report, and select Share Analysis Item.

   2. In the Share Analysis Item dialog box, select a share option. For details of the options, see Share Analysis Item Dialog Box.

      A URL of the selected report is copied to the clipboard.

   3. Paste the URL in a website or email.

   4. Click the URL to open a read-only version of the report in a Web browser. Each time you access the report, after set intervals, it displays the most up-to-date information.

      Note: You can change the frequency at which report data is updated by adding and configuring the REPORT_RESULT_LIFESPAN site configuration parameter. For details, refer to the Micro Focus Application Lifecycle Management Administrator Guide: Setting ALM Configuration Parameters.

   Available from: Analysis View module