Change Management Reports are typically defined to give some type of an overview of selected issues, similar to issue Views. A report can, however, include information in any kind of form or structure.



Creating Public and Private Issue Reports


Prerequisites

  • You must have "Write" access rights to the CMS project to create private reports
  • You must have "Change" access rights to the CMS project OR the Administrator role in the server to create public reports


Private reports are created by you and are only visible to you. 

Public reports are created by project administrators, i.e. those with "Change" rights to the project, or by system administrators, and are visible to all users with access to the project.

  1. To create a private report, right-click on the Private Reports menu option and select New Private Report. To create a public view, right-click on the Public Reports menu option and select New Public Report.

  2. Enter a Name for the report and click OK. This name will display in the report selection menu. Regardless of whether you are creating a private or public report, the New Report dialog will display the Definition edit screen.



  3. Enter a Definition for the report. A complete list of report-specific XML tags can be found in the Basic SystemWeaver Script Language section in the Help.
  4. To preview the report, click the Report button at the top-left. 
  5. To save your report definition at any time, click OK.


Example Reports


Definition 1

<Report>
<!--Returns a list of all issues-->
<ForEachIssue>
<IssueHeader/>
<Text>Description:</Text>
<Description/>
<!--Returns a list of all obj (item or issue) which reference the current issue-->
<ForEach select="/objref::IR">
<!--Writes a Item references Name -->
<Text>Item references Name: #{Name}</Text>
<!--Writes a Item references attributes of SID = IDTEST -->
<Text>Req ID: #{? @IDTEST}</Text>
<!--Writes all attributes of a Item references-->
<AttributeTable/>
</ForEach>
</ForEachIssue>
</Report>


Result 1


Definition 2

A report that prints out all requirement change orders. In the set-up of this project, a change order issue type has three different relationship types:

  • Added requirements (VDEL)
  • Deleted requirements (NREQ)
  • Referenced logical component (IR)

This report lists issue_Id, issue_name, referenced logical component, added/deleted requirement in a table format. 

<Report>
<Table autoMerge="True">
<Columns>
<IssueIdColumn caption="ID" objectName="Issue" width="20"/>
<NameColumn caption="Issue Name" objectName="Issue" width="200" />
<TextColumn caption="Logical Component" objectName="LC" width="200">#{Name} #{Version}</TextColumn>
<TextColumn caption="New Design Requirement (Version)" objectName="NRQ" width="250">ID: #{@IDTEST1} Title: #{Name} #{Version}</TextColumn>
<TextColumn caption="Deleted Design Requirement (Version)" objectName="DREQ" width="250">ID: #{@IDTEST1} Title: #{Name} #{Version} </TextColumn>
</Columns>
<ForEachIssue>
<RowObject name="Issue">
<Row>
<!--Referenced logical component-->
<ForEachObjInIssue type="IR">
<RowObject name="LC"/>
</ForEachObjInIssue>
<!--Added Requirements-->
<ForEachObjInIssue type="NREQ">
<RowObject name="NRQ"/>
</ForEachObjInIssue>
<!--Deleted Requirements-->
<ForEachObjInIssue type="VDEL">
<RowObject name="DREQ"/>
</ForEachObjInIssue>
</Row>
</RowObject>
</ForEachIssue>
</Table>
</Report>


Result 2


Printing Reports

To print an issue report to PDF, right-click anywhere in the issue report display area and select Print. A Print Review option is also available. 


Note: Printing to PDF requires that you have a PDF printer installed.


Modifying, Renaming and Deleting Reports

  1. An issue report can be edited, renamed, or deleted by using those options in the right-click context menu.