Reports User Interface
When you click the Reports tab on the Codebeamer home screen, the New Report dialog box opens, as shown below:
1. My Reports
2. New Report
3. Fields
4. Filter list
5. New Report
6. Find Report
7. Export to Office
8. Project List
9. Tracker List
10. Filters box/pane
11. Group by
12. Order by
UI Component | Description |
---|
| Creates a new report. |
| Opens the Report and Traceability Report Finder where you can search for and open the required report. For details, see Finding a Report. |
| Exports the results from the result table into an Excel sheet. |
Filter Section | Allows you to use the filters as follows: • Add Filter: Displays a list of filters. You can select multiple filters and search for the required tracker in the results table. For more information on Add Filter, see Filtering Reports • Remove All: Removes all the applied filters. • Add AND/OR: Provides a number to the applied filters These numbers represent the filters that have been applied. For more information, see Filtering Reports. |
Group By | Allows you to group the results in the results table, based on the selected fields. For more information, see Group by section |
Order By | Allows you to set the order of the results as ascending or decreasing, for the selected field type. For more information, see Order by section |
Project | Allows you to select the required project from the list. |
Tracker | Allows you to select the required tracker from the list depending on the selected project type. |
Traceability Report | Correlates any number of sets of any trackers or tracker types in a desired order. In addition, visualizes the dependencies between the items corresponding to the neighbouring selected trackers or tracker types. For more information, see Traceability Browser |
My Reports | Allows you to see your reports as follows: • Predefined Reports: Displays My Unresolved Items and Submitted by me. • My Starred Reports: Displays the reports that have been marked as starred. |
| Create a shareable URL with the selected settings. |
Expert | Allows you to use a special text-type filter that accepts cbQL strings. |
Structure of the screen
There are three main sections of the Edit screen:
• Field section—The left pane displays the available fields in a tree format. By default, commonly-used fields in most trackers and common reference fields are displayed. You can drag and drop these fields to the Filter list, Group by and Order by sections, and the Result table header. After you start dragging a field, the sections where you can drag the fields to are highlighted.
| In case of custom fields with Per Status permission configuration, you can select only the fields that have at least Read permission by default. |
• Report properties and filter section—The center pane displays the name of the report, the context menu, Save, the editor section , Go, and the switch to the Advanced mode. Result: The lower pane displays the filtered tracker item table after you click Go or when you edit an existing report, according to your settings.
• Result—Center bottom after clicking Go (or in case of editing an existing report) you can find the filtered Tracker Item list in a table according to the set options.
Advanced mode
Next to Go, you can switch to the Advanced mode. In the Advanced mode, you can see only the syntax highlighted cbQL of the report. The project or tracker selector, filter list, group by, and order by areas disappear, and an editable text area is visible.
| If you use AND/OR Logic, the cbQL is not editable. |
The Advanced mode supports some cbQL functions, such as escalation-type cbQL functions, that are not supported in the Simple mode. The Advanced mode also allows for more complex AND, OR, and NOT logic. If you prefer the cBQL language over drag-and-drop operations, you can create your own cBQL in the Advanced mode. You can switch back to the Simple mode only if it supports your cBQL, that is, if the cBQL is not too complex and it is syntactically correct. If the Simple mode does not support your cBQL, a warning appears and you remain in the Advanced mode.
When you save your report from the Advanced mode, Codebeamer marks the report as advanced. Subsequently, the report opens in the Advanced mode by default.
Show Ancestor and Descendant Items
Similar to the Filter widget of the table or document views, you can include ancestor (parent) and descendant (child) items of the result if only one tracker is selected in the report. To include ancestor or descendant items in a view, select one of the checkboxes when you run a report.
| Switching on any of these settings disables Grouping and Ordering. |