Creating matrix reports

1. Choose Create > Report.

The Select Report Type dialog box opens.

2. Select Matrix and click OK.

The Add Matrix Report dialog box opens.

3. Enter a Name. You can enter up to 128 characters.

This identifies the report in the Reports list window. The title displayed in the report is configured in the header.

4. Select a Share with option.

• No one restricts other users from using the report.
• Everyone shares the report with all users and customers.
• All users shares the report with other users.
• All customers shares the report with customers.
• Security groups shares the report with selected security groups.

You can add up to 100 columns to a matrix report and arrange them in any order.

• To add a new column, click Add Column. The new column is added as the last column to the right in the matrix.
• To duplicate an existing column, click in the column header. The new column is added to the right of the column you duplicated.
• To move a column, click and in the column header.

• To delete a column, click in the column header. Click Yes to confirm the deletion.

Column rules limit the items displayed in a column by type, item relationships, relationship types, filters, folders, and other criteria.

You can add multiple rules to a column to display different item types and relationships.

1.Click Add Rule in the column to add the rule to.

The Add Column Rule dialog box opens.

2. Select the item type that the Column contains.

3. Select a Related to option to limit the items displayed in the current column to related items in another column. This option is not available for the first column in the matrix.

The list only includes columns to the left of the current column. Select <No Related Column> if the current column is not related to other columns.

4. Select Relationship restrictions to limit the items displayed in the current column based on relationships. These options are not available for the first column in the matrix or if a column is not selected in the Related to field.

• Select Has any of the following relationships to include items in the selected relationships. Select Does not have any of the following relationships to include items that are not in the selected relationships.
  • Select the relationships to include or exclude. Select <All> to include or exclude all relationships or select specific relationships. If you select <All>, links or relationships added in the future are included when reports are generated.
  • Select Parents, Children, or Peers to indicate the relationship types to include or exclude.
• Select Same items as related column to include the same items from the column selected in the Related to field. Selecting this option makes it easier to format information displayed from the same items and makes important field values more visible.

5. Select any Item restrictions to limit the items displayed in the column based on filters, folders, and other criteria.

• Select a Filter to only include items that pass the filter criteria.
• To only include items from a specific folder, click Browse to select the folder. Select Recursive to include child folders of the selected folder. Click Clear to clear the selected folder path.
• If the column contains test runs, optionally select a Test Run Set to include only test runs in the selected set.
• If the column contains requirements, select a Requirement Document to include only requirements in the selected document. Click Browse to select the document. To find a document, you can search, go to a specific document number, apply a filter, or select the <Recent Items> filter to view a list of recently accessed documents. Click Clear to clear the selected document.

6. Click OK to save the changes.

The rule summary is displayed in the column.

Note:  To edit a column rule, click Edit above the rule to edit. To delete a rule, click Delete.

The column text settings determine the item content and formatting. You can configure text for each item type included in the column.

1.Click Edit in the Column Text row for the column to change.

The Edit Text dialog box opens. The default text for the item is displayed.

2. Make any changes.

You can use text and field codes, which are replaced with information from specific items when the report is generated. For example, the %RQSUM% field code is replaced with the requirement Summary field value. Click Insert Field Code to select from a list of available field codes. See Field Codes for field code information.

The following additional field codes are only available for matrix reports:

Field code	Description
%ENTITYIMG%	Image that represents the item type. All requirement types use the same requirement image.
%RELATIONIMG%	Arrow images that represent the relationships of the item:
	Child in a link
	Child in a relationship
	Parent in a link
	Parent in a relationship
	Peer in a link
	Peer in a relationship
%RUNRESULTIMG%	Image that represents the test run result (passed, failed, or undetermined).

3. Apply any formatting.

You can use text formatting, images, tables, and links. See Formatting text fields. If a style is applied to a list field value and the Display field text with formatting option is selected, the field text uses the style formatting in the report.

4. Select Display field text with formatting to display text from item multi-line text fields the same way it is formatted in the item and display values from list fields with the style applied to them.

5. Select Apply style from field and a list field to display the cell in the report with the background and text colors from the style applied to the value set in the field.

6. Click OK to save the changes.

The display settings control how the column is displayed in reports, including the column name, sorting, and width.

1.Click Edit in the Display Settings row for the column to change.

The Edit Display Settings dialog box opens.

2. Enter the Header label. You can enter up to 64 characters or leave the field empty. The field is only available if an extra header row is added to the report. See Adding and editing an extra header row.

3. Enter the Column label. You can enter up to 64 characters.

4. Select a Primary or Secondary Sort field and set the sort order for items in the column.

If multiple item types are displayed in the column, the available fields only include fields that both item types have.

5. Set the Column width in inches, centimeters, or pixels. You can enter up to two decimal places.

Select Ignore width if content exceeds it to display all content in the column even if it exceeds the width setting. If this option is not selected, content that exceeds the column width is not displayed. For example, you may want to select this option if items include large images and you do not want to truncate them.

6. Click OK to save the changes.

The settings are displayed in the column.

You can add an extra header row above columns and merge the header cells to group related columns.

• To add an extra header row, click Add Extra Header Row. You can only add one extra header row.
• To merge a header with the column header to the right, click . Continue merging the header until it spans all related columns.
• To edit the extra header label, click the text in the header cell or click the text in any column header under the cell.
  • If the extra header only spans one column, the Edit Display Settings dialog box opens. See Editing the column display settings.
  • If the extra header spans multiple columns, the Edit Header Label dialog box opens. Enter the header label text and click OK. You can enter up to 64 characters or leave the field empty.
• To split merged headers, click . The header is split into individual cells with the same text above the columns.
• To delete the extra header row, click Delete extra header row. Click Delete to confirm the deletion.

The report header is displayed at the top of the report and typically includes the report title. The footer is displayed at the bottom of the report. You can use any text in the header and footer and format the text.

1.Click Edit Header or Edit Footer.

The Edit dialog box opens.

2. Make any changes.

You can use formatted text, images, tables, and links. See Formatting text fields.

3. Click OK to save the changes.

You can set options for how the report is displayed.

• Select Alternate row background colors to use different background colors in alternating rows to make the report easier to read.
• Select Display column headers on each printed page to include column headers on each page of the report.

1.To preview the report, click .

2. Click Add.

The report is added. See Running built-in reports for information about running reports.

Tip:  You can view the report in Microsoft Excel after saving it. Run the report to open it in a browser and save it as HTML. In Excel, open the saved HTML file. To select the file, change the filter in the Open dialog box to All Files (*.*).