Adding 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 for the report. 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 prevents all other users and customers 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 the selected security groups.

You can specify and limit the items displayed in a column by type, item relationships, relationship types, filters, folders, and other criteria. You can display multiple item types and relationships in one column.

1.Click Add Items in the Items To Display area in the column.

The Add Items To Display dialog box opens.

2. Select the item type that the Column contains.

3. 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 you are adding restrictions for the first column on the left and want to be prompted to select a folder when running the report, select Prompt for folder at run time. If this option is selected, you are prompted to select a folder when previewing or running the report instead of using the selected folder in the report settings. See Selecting interactive criteria when running matrix reports. If you select a folder for the Item Restrictions, it is set by default when you are prompted at run time, but can be changed. This lets you create more flexible reports because you do not have to use a specific folder every time you run the report.
• 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. If you are adding restrictions for the first column on the left and want to be prompted to select a document when running the report, select Prompt for requirement document at run time. If this option is selected, you are prompted to select a document when previewing or running the report instead of using the selected document in the report settings. See Selecting interactive criteria when running matrix reports. If you select a document for the Item Restrictions, it is set by default when you are prompted at run time, but can be changed. This lets you create more flexible reports because you do not have to use a specific document every time you run the report.

4. If the report contains more than one column, select a Related to option to limit the items displayed in the current column to related items in another column.

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.

5. If the report contains more than one column and a column is selected in the Related to field, select Relationship restrictions to limit the items displayed in the current column based on relationships.

• 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 in reports.
  • Select Parents, Children, or Peers to indicate what type of relationship items in the column are in.
• Select Same <items> as <column> 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.

6. Click OK to save the changes.

A summary is displayed in the column.

7. Repeat the steps to add additional items to display in the column.

Note:  To change the items to display in a column, click Edit above the summary. To remove the items to display, click Remove.

You can specify the field values and text to display for each item type in a column. Each column has default text, but you can change it. You can use text, images, diagrams, tables, and more to format the content. You can also use field codes to include specific field values in a column. Field codes are replaced with information from specific items when the report runs.

1.Click Edit in the Fields To Display area in the column.

The Edit <Item Type> Fields To Display dialog box opens. Default text for the item type is displayed.

2. Make any changes to the text and field codes.

For example, the %RQSUM% field code is replaced with the requirement Summary field value when the report runs. 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
%RQ_OUTLINE_NUMBER%	Outline number for a requirement in a requirement document. Only available if the column contains requirements. If a column contains multiple instances of requirements and different selected requirement documents, and the documents contain shared requirements, the outline number from the first document found is used.
%RUNRESULTIMG%	Image that represents the test run result (passed, failed, or undetermined).

3. Apply any formatting.

You can use text formatting, images, diagrams, tables, and links. See Working with 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 column settings specify the column name, sorting, and width.

1.Click Edit in the Column Settings area in the column.

The Edit Column 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 used to group columns in the report. See Grouping columns with 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, only fields that both item types have are available for sorting. If the first Items To Display rule in the first column in the report contains requirements with a specific requirement document selected, the Primary sort field is automatically set to Outline Number (ascending), but you can change it. This sorts the requirements based on the outline order in the selected document. The Outline Number sort option is only available if the column contains requirements with a specific document selected.

5. Select Hide column to hide the column when you preview or run the report.

6. If this option is selected, the Column width and Ignore width if content exceeds it options are not available.

7. 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.

8. Click OK to save the changes.

The settings are displayed in the column.

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.
• 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 Delete to confirm the deletion.

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

• To add group columns using an extra header row, click Group Columns. You can only add one extra header row.
• To group a header with the column header to the right, click . Continue grouping 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 Column Settings dialog box opens. See Editing column 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 grouped column headers, click . The header is split into individual cells with the same text above the columns.
• To ungroup columns and delete the extra header row, click Ungroup Columns. Click Delete to confirm ungrouping the columns and deleting the row.

The report header is displayed at the top of the report and typically includes the report title and other information, such as a logo. The footer is displayed at the bottom of the report. You can use formatted text, images, tables, and links in the header and footer.

1.Click Edit Header or Edit Footer.

The Edit dialog box opens.

2. Make any changes. See Working with 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 .

To save the report as a PDF, click Save Report As PDF. See Saving reports as PDFs.

2. Click Add.

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