You are not logged in. Click here to log in.

codebeamer Application Lifecycle Management (ALM)

Search In Project

Search inClear

Tags:  not added yet

Reports

Reports is a new project independent way (since 8.0) to search/filter work items ad-hoc or for later reuse across multiple projects using cbQL .

Handling Reports

New Report

By default clicking on Reports menu opens a New Report, you can create simple report via the query condition editor or complex queries in advanced mode using the cbQL syntax.

In the query condition editor, for the username field as " Assigned to" field, if the accountLink is set and it is not empty on the system admin page, we can use the username in parentheses instead of the first/last name. In any other cases the options display the realName first (firstName, lastName) and then the userName and domain within the parenthesis (since 10.1).

Save Report, Properties

When first saving your query you need to give it a name and optionally you can add roles from projects that you want to share the query with and a description. Two kind of access level can be assigned: read and write, write also gives read permission.

When assigning permissions you select a project you have access to and then select one or multiple roles from multiselect menu. If the current report contains one project, this project will be preselected and its roles will immediately appear in role selector. Once you select the role(s), the role(s) and its/their project(s) will appear with a default READ permission. You can change the access level row-by-row to WRITE if you want. If you do not have permission to view the roles of the selected project, a warning message will shown and the role selector will be empty.

After the first save you can simply update your query with the Save button the properties window will not popup, if you want to modify other aspects of the query you can use the context menu Properties option.

If you select Save as... from context menu, the Properties popup will also appear and you can change the name/permissions, after saving a new Report will be created with the newly set properties.



View Mode and Edit Mode

There are two modes of the reports, view mode and edit mode. For users with read-only access, the edit mode is not available. With write access, it is possible to switch between the two modes with by clicking View Mode or Edit in the action bar.

In View mode, users can only see the name and description of the report and the result table. In-place edit is available from both modes. For more information, see You must login to see this link. Register now, if you have no user account yet..

In the My Reports section, the starred reports and some of the predefined reports are available.



Direct Edit Mode

Since Codebeamer release HUSKY, the Direct Edit Mode allows the changing of the report settings without having to run the reports.


Enable the Direct Edit Mode by setting the value of the "reportEditWithoutLoading" to true in the Application Configuration.


You can enter the Direct Edit Mode in two ways:

  • Click the Reports tab > Find Reports > Report Finder, and click the Edit icon next to the name of the relevant report.
  • In View Mode, click the Edit icon in the relevant report.

To load the reports in Direct Edit Mode, click the GO button, or select any of the Show Children, Show Ancestor Items, Show Descendant Items checkboxes.


When a report is opened for the first time in Direct Edit Mode, the results are not loaded immediately. The "Please press the GO button to load the results." notification is displayed next to the Expert link to warn the user that the GO button must be clicked.

Find Reports

Clicking the arrow next to the Reports tool menu, you will see the recently opened reports at the bottom. Clicking on these report, these will open in View Mode. From the context menu you can create New Report, reach the old report functionality Reports (Vintage) and you can find existing reports. Clicking on Find Reports, an overlay appears in which you can see your own reports and the reports which are shared with you via project roles.

It is able to filter the report list: you can type a text into the filter input or you can switch between own and shared reports using the checkboxes. Once you click on a report, it will be loaded in View Mode.

Find Reports is also available from the action bar of a report both in View and Edit Modes.

Delete Report

Using the context menu of the current report you are able to Delete Report.

Edit Report

Structure of the screen

There are three main sections of the Edit screen:

  • Field section: on the left panel you can see the available fields in a tree. By default the Default fields (commonly used fields which are available in most of the trackers) and the Common Reference fields appearing. The fields can be drag&dropped to the other parts of the screen: Filter list, Group by/Order by sections, Result table header. The available places where you can drop will be highlighted once you start dragging a field.
In case of custom fields with Per Status permission configuration, only the fields having at least "Read" permission by default are able to be selected.
  • Report properties and filter section: on the center panel top you can see the name of the report, the context menu, the Save button, the editor section (the Project and Tracker selectors and the Field Filter, Group by and Order by lists), the Go button, and the switch to Advanced mode option.
  • Result: center bottom after clicking on Go button (or in case of editing an existing report) you can find the filtered Tracker Item list in a table according to the set options.

Project and Tracker selectors

The two most commonly used filter option is by Project and Tracker. Once you select any projects, the trackers of the selected projects will appear under the Trackers dropdown list. Once you select any trackers, the field tree on the left will extend with the custom fields of the selected trackers (the fields which are not under the Default fields and Common Reference fields). Furthermore if you choose only one tracker, the labels of the Default and Common Reference Field will change to the field labels of the selected tracker.

Branch support

Branch support is only available from codeBeamer 9.0.0.

From codeBeamer 9.0.0 you can select also the branches of the trackers. Within the tracker selector under each tracker you will see the hierarchy of the branches of the tracker if exists. Branches are selectable just the same way as you select trackers.

Filter list

This is the most important section of the screen. To add a filter by a field either you can use the Add filter button or you can drag the proper field into the filter section. After you select or drop a field, a small control overlay will appear in which you can set the desired options. These controls depend on which type the field has. The following field types are supported:

Choice fields / meaning type selectors

The possible values of these fields depend on which trackers are selected in the Tracker selector, in the list you will see the field values grouped by the selected trackers. Once you select or deselect tackers in Tracker selector, these fields will be refreshed automatically and will show always a consistent state.

Furthermore if you select Status or Resolution, you can filter also by meanings of the field values. The Status and Resolution meanings for values can be set on Tracker customization page. On Query widget the meanings do not depend on selected trackers, have fix values, which are the followings:

  • Status: Unset, In progress, Resolved, Closed, Obsolete
  • Resolution: Unsuccessfull, Successfull, Obsolete

You also can use the Filter option inside these selector for filtering meanings / field values.

User fields

From codebeamer 21.04 the filter of Member type fields were completely redesigned.

You will see an autocomplete input for selecting Users and User Groups and you can use also the pencil icon to find the member. The role list of the current project (or selected projects) will be displaying below the autocomplete input. Also, you can select "Me" from these part.

Filter by Members in previous versions

By selecting these conditions, you will see a list of users depending on which projects are choosen in the Project selector. If you do not select any projects, all of the visible members of the projects assigned to the current user will appear. At the beginning of the values there is a "Me" option which means the current user. The values of these fields are also refreshing automatically if you change projects in the Project selector.

Three properties of the users are appearing in the list: the user name (or user alias configured in general.xml), the real name, and the domain of the user's email address. You can filter by these three properties if you begin to type in the Filter input box inside the selector.

From codeBeamer 8.2 you are able to select users which are not presented in the list by clickin Add Other User(s) link. A dialog opens and you can begin to type to select the desired user(s). If you are ready, click on OK button, and the selected user(s) will appear in the user selector list.


Date fields

By selecting date conditions, you will see a small control box, in which you can set your date ranges. Three options are available:

  • Predefined date ranges: e.g Today, Today and Yesterday, This week, etc. Possible values are grouped in the list by day/week/month/quarter/year.

  • Specific dates: you have to select two dates using the datepicker. If you want, you can skip the "form" or the "to" values, just leave the input empty.

  • Relative custom date ranges: you can set relative Custom date ranges also, by setting the from and to dates using the selectors: number of days/workdays/weeks/months/quarters/years before/after today. Click on the checkboxes before from/to labels if you would like to skip any of these values.

Number fields

You can filter by number type field of tracker items. You should set the operator (greater than >, greater than or equals to >=, equals =, less than or equals to <=, less than <) and the integer number.


Item ID filtering

From codeBeamer 10.1 you are able to filter by Item ID. Select Item ID from the Default Fields, and you can enter a comma separated list of Item IDs.


Duration fields

You can filter by duration type field of tracker items. You should set the operator (greater than >, greater than or equals to >=, equals =, less than or equals to <=, less than <), the integer number and the duration (hour, minute, second).

Text fields

You can filter by text field of the tracker items. SQL wildcards and negation are allowed to use here. Example: if you would like to see tracker items where the summary not contains "test", you should type here: "%test%" and check the "not" checkbox.

Boolean fields

Boolean fields are supported only from codeBeamer 9.2.

You can filter by any custom boolean fields.

Color fields

Color fields are supported only from codeBeamer 9.2.

If you select color field, you will be able to pick a color using the colorpicker and filter the result by color.

Reference fields

You are able to filter tracker items by references. By clicking a selected reference field, a small overlay opens, in which you can set the desired referring tracker items. Firstly you have to select one ore more project(s) then one or more tracker(s), and then you can use the autocomplete field or the pencil icon to select the tracker items. The projects and trackers could filled out according to the selected trackers and the set field reference (e.g. if Bugs tracker is selected in Tracker selector, and you drag and drop Release reference field, the trackers will be preselected according to the Bugs tracker Release field reference setting). Only valid items will appear, so according to the selected trackers. Between the selected items there will be OR connection.

Optionally you can filter by suspected/not suspected references, three possibilites are available:

  • Do not filter
  • Suspected References
  • Not Suspected References

If you leave the work item input empty, and select Suspected / Nor suspected filter, you can filter ont the field level. E.g. if you select Suspected references and leave the work item input empty, all work items will match where Release field contains at least one Suspected reference.


From codebeamer 21.04 you are able to filter by the name of reference items using asterix / wildcards. Please note that this functionality is not supported for Parent and Children fields nor for reference type Shared Fields. Once you begin typing on the input field of the Filter by Summary of Reference Items part, the upper part will be disabled and the search will perform according to the typed text. You can use the same operators as you can use by filtering a text field (like, grater than, equals, etc.).

In this example, search will perform on the Backlog Item field where the name of the reference item contains the "voice" text.


Has Association

Has Association is a general filter which returns those tracker items that have at least 1 association, regardless of which other tracker item(s) they are associated with.



Filtering criteria


1. Has Association

  • By selecting the Has Association filter from the accordion, its default value is automatically set to True. To execute the filtering without providing any further filtering criteria, click on [GO].
    It is not specified that the association(s) of which tracker item is to be returned as the result of filtering, thus, all those tracker items will be listed that have at least 1 association.

2. Filtering by Suspected References

  • Suspected References - By adding the Suspected References to the filtering criteria, those tracker items will be listed that have at least 1 association.
  • Not Suspected References - Adding the Not Suspected Referencesto the filtering criteria will return both:
    • those associated tracker items in case of which the Propagate Suspect function is set, but the association target has not been modified since creating the association. These items are indicated withlabels;
    • and those associated tracker items for which the Propagate Suspect function is not activated.


      For more information on Suspected References, see: Document View for Requirements

3. Association type

  • The Has Association filtering result can be further refined by adding the relevant Association type to the filtering criteria.
  • Association types:
    • Any
    • Depends
    • Superordinate To
    • Subordinate To
    • Related
    • Derived
    • Violates
    • Excludes
    • Invalidates
    • Copy of

  • E.g.: Executing a filtering with the Suspected References and the Related type of association added to the criteria will return those tracker items that have at least 1 Suspected, Related type association.


Has Association To

The Has Association To filter enables the selection of one or more tracker item(s), and returns all those tracker items that have at least 1 association to the selected item(s).




Filtering criteria


1. Please select one or more Projects! - The relevant Project(s) can be selected from the accordion for the filtering.


2. Please select one or more Trackers! - The relevant Tracker(s) to be selected from the accordion for the filtering.


3. Filtering by Suspected References

  • Suspected References - By adding the Suspected References to the filtering criteria, those tracker items will be listed that have at least 1 association to the selected tracker item.
  • Not Suspected References - Adding the Not Suspected Referencesto the filtering criteria will return both:
    • those tracker items associated to the selected tracker item(s) in case of which the Propagate Suspect function is set, but the association target has not been modified since the creating the association. These items are indicated with labels.
    • those tracker items associated to the selected tracker item(s) for which the Propagate Suspect function is not activated.

For more information on Suspected References, see: Document View for Requirements


4. Association Type

  • The Has Association To filter can be further refined by providing the relevant type of association to the selected item.
  • Association Types:
    • Depends
    • Superordinate To
    • Subordinate To
    • Related
    • Derived
    • Violates
    • Excludes
    • Invalidates
    • Copy of

5. Please begin to type or click on the pencil icon to select one or more Work Items!

  • One or more tracker items to be added to this field the associations of which the filter should return.
  • The appropriate tracker item(s) can be added either by starting to type the name of the item(s), or, by clicking on the icon, selecting the relevant ones, then clicking on [Add].

  • The filtering is executed by clicking on the [OK] button.
If no items are selected, this filter defaults to hasAssociation() in Expert mode.

Tag Filters

From codeBeamer 9.3.0, you can also filter work items using Tag filters. CodeBeamer supports the following types of tags:

  • Project Tag
  • Tracker Tag
  • Work Item Tag
  • Release / Sprint Tag

When you select a Tag filter from the filter list, a text field is displayed where you can insert the name of the tag that you want to use to filter work items. If you start typing the name, the autocomplete function will display the list of matching tags to select from:


Item Based Review Filter

From codeBeamer 10.1 you can filter by Item Based Review. Select Reviewed by option under Item Based Review Filters. You are able to select if you want to search for Pending and/or Decided reviewed items, or for items which are Not participated in Item Based Review. Optionally you can filter additionaly for the reviewer users.

Please note, that if you select NOT, the negotiation will apply only for the selected users.


Filtering by Shared Fields

From codeBeamer 10.0.0. you can filter by any type of Shared Fields.

If you select a project and some trackers, only those Shared Fields will appear, what are used in the selected trackers. On Tracker Views only the used Shared Fields will appear in the current tracker.

Other filters

From + Add filter menu you can select other filters too. These filters do not represent any field, that is why they are not present in the left tree.

  • Has Reference to / Has Reference from: similar to the Reference field, but without the field being specified. Optionally filterable by suspected references.
    If the "Filter by Work Item(s)" section is closed or the work item input is empty, you can filter by tracker level. E.g. the following case means that those work items will match which have at least one reference from the Bugs tracker:

    If you open the "Filter by Work Item(s)" section and set some work items, you can specify the references:
  • Has Downstream Reference / Has Upstream Reference: these are simple boolean options, you can find which Tracker Items has downstream/upstream refrences or not. Optionally filterable by suspected references also.
  • Has Review / Is under Review: simple boolean options, filter work items by their Review(s).
  • Suspected References (Has Suspected Link / Has Incoming Suspected Link / Has Outgoing Suspected Link): simple boolean option, filter by suspected links without field, work item specified.

    See also: hasSuspectedLink.
  • Outline filtering: from codeBeamer 9.4.0. you can filter items according to their outline number (Document View paragraph numbers).
  • Tracker Type: from codeBeamer 10.0.0. you can filter by Tracker Type. The obsolete Tracker Types are listed as gray, but they are still selectable.

Include

From codeBeamer 9.3.0 you can include other Report into an existing Report. Use Include option of + Add Filter menu, and you will have two options:

  • Include Report: you can select an other Report by autocomplete or using the pencil icon and the Report Finder.
  • Include cbQL from Work Item Description: if you have any work item which contains cbQL in its Description field, you can select here the item and the cbQL will be included into the existing Report.


Historical Filters

From codeBeamer 9.4.0, you can display specific versions of items - versions that items had at a specific point in time (based on a Baseline or a specific date). If you use a Historical filter, the result items will always be versioned items, so the result table will be read-only.

  • Historical View: filter by baseline or date. Baseline filtering is available if you select only one project and the project has at least one Baseline.
  • Items at Release/Sprint Start Date: if you choose this option, you can select a Release or Sprint. The result will be the versioned items of the selected Release/Sprint at the time of the date value of the Start Date field of the Release/Sprint.
  • Items at Release/Sprint End Date: if you choose this option, you can select a Release or Sprint. The result will be the versioned items of the selected Release/Sprint at the time of the date value of the Planned Release Date (End Date) field of the Release/Sprint.

Historical filters have the following limitations:

  • Historical filters are a built-in part of every project, they cannot be disabled or customized.
  • The result items cannot be edited because these are versioned items.
  • Only one historical filter can be used at a time.
  • Historical filters are not available in the following places:
    • Release/sprint planner
    • Baseline mode
  • The query performance might be decreased when any of the historical filters is active. The following warning is shown: Using historical filters may lead to poor query performance.
  • Historical filters cannot be used together with the following filters:
    • Custom and shared fields, apart from choice option and member type fields
    • Description field
    • Has downstream reference
    • Has upstream reference
    • Has unresolved dependent link
    • Suspected link filters
    • Review Hub filters
    • Reviewed by
    • Project tag
    • Tracker tag
    • Work item tag
    • Has rank
  • When an unsupported filter is selected, the following warning is shown:
    <Filter> is not supported if you use any Historical filters or if you are in Baseline / Baseline compare mode.

Filtering by fields of Reference Items

From codeBeamer 10.0.0 you are able to filter by attributes of Reference Items. You have to options under Filtering Refertence Items group:

  • Downstream References
  • Upstream References

Select one of the options. A Filter Widget will appear in the overlay, where you can set any kind of filters. Optionally you can define in which reference field should the filtering happen. Only the default Common Reference Fields and the Shared Fields (which have Tracker Item Reference Type) will be selectable here.

In this example the result will display the items, which has In progress Bugs upstream reference items in the Upstream Reference field.


Expert Filter

Expert filter is supported only from codeBeamer 10.1.

This one is a special text-type filter: it accepts cbQL strings. The execution environment copies the content of these filters into the filtering part of the final cbQL expression.



You can enter the expressions into the text editor. This editor supports syntax highlighting and also displays syntax errors.



You can only enter filtering expressions, changing projection, grouping or ordering is not allowed.


NOT and EMPTY options

Using any type of field types there is ability to negate the condition using the NOT badge on the right top section of the selector. If selected the light gray background of the badge will be darker and the "not" word will appear in the filter stripe before the selected conditions.

You can filter also for emptyness of a field value. A field value of a Tracker Item could be empty if the field is not mandatory, but it is not set. E.g. if you would like to see the items which does not belong to a Release, you can add the Release field to the filter list and set it to empty. If selected the light gray background of the badge will be darker and the "empty" word will appear in the filter stripe.

You are able to combine the NOT and EMPTY badges, so with these two badges you can reach three states:

  • NOT badge is on: negation of the selected condition.
  • EMPTY badge is on: filter for empty field value. In this case the selectable elements within the setting container will be disabled (e.g. the choice options of a choice field).
  • NOT and EMPTY badges are on: filter for not empty field value. Selectable elements are also disabled.

Group by section

You are able to group the result by project, trackers and some fields. If you start dragging from left pane tree, the Group by section will be highlighted if the grouping is available for this field (grouping by custom field is also available). For grouping by project and/or tracker, you have to use the Add button inside the Group by section. Multiple grouping is also supported (maximum 3 levels).

In case of grouping by date type fields, you can also use truncate functions (Day, Week, Month, Quarter, Year). You can switch the truncate function by clicking the darkgrey background truncate funcion badge.

Grouping is neccessary to use the Aggregate functions (see below).

From codeBeamer 9.1 it is able to Group by Custom fields, but only if exactly one tracker is selected in the tracker selector. It means, that custom fields appear under Add Group by context menu only if you selected exactly one tracker in the tracker selector. If you already have one tracker selected and a custom field of the tracker in the Group by section, and later you select other tracker(s) or set the tracker selector to Any, the selected custom field within the Group by area will be removed.

Order by section

Order by is also supported for most of the fields, you can just easily drag&drop the desired fields. For ordering by Tracker or Item ID, you have to use the Add button inside the Order by section. Multiple ordering is also supported (maximum 3 levels).

You can change the direction of ordering (ASC or DESC) by clicking the dark background direction badge.

Order groups by summarized values

In certain cases you are able to order the groups by the summarize function values. The control badge for that is available only if the following conditions match:

  • the report is grouped, and grouped by only one field
  • some of the Summerize function are set for a number type field (SUM, AVG, MIN, MAX)
  • this number type field is selected in Order by area

The order by aggregate badge will appear after the ASC/DESC badge and will contain the selected summarize functions and the NONE option. If you select NONE, the default ordering will be present, so not the groups but the Tracker Items will be ordered by the field value.

AND/OR Logic

By default there is AND condition between the filters in the Filter list, but you are able to define custom logic (using AND/OR and parentheses) by clicking the + Add AND/OR button next to the + Add filter button inside the Filter list. Once clicking, the Filter list goes to AND/OR Logic mode, the structure changes a bit:

  • All of the added filters get a number, the numbers will represent the filters.
  • An AND/OR Logic input field appears top of the area in which you can type the custom logic using the filter numbers, the AND, OR logical operators and parentheses if necessary.

If you begin to type into the AND/OR Logic field, the logic is being validated immediately. If the typed logic is invalid, a red alert appears, and once it became a valid logic, the text colour will be green and the alert disappears. You can run the Report only if the AND/OR Logic is valid.

  • Invalid logic:
  • Valid logic: you can use uncapitalized format too, the logic validation is case insensitive

Please note, that if you switch to Advanced mode while using AND/OR Logic, the cbQL is not editable. If you need to modify it anywy, you have to copy the cbQL and create a nem Report with advanced mode or go back to Simple mode and switch off the AND/OR Logic mode.

To switch off AND/OR Logic mode, click on the X button right inside the stripe.


Current Project functionality

From codeBeamer 9.3.0 there is a new option under Project selector of the Reports page, called Current Project.

Using this option you do not need to define the project of the Report, so if you use later the Report in project context, the current project will be preselected. This is useful if you have Reports which are data sources of Dashboard widgets (e.g. Table Widget or any kind of Chart Widgets), and you want to use them on the Dashboard pages of multiple projects - you do not need to create as many Reports as many projects you have, just save one Report and use the Current Project functionality.

On Report page, if you select Current Project and hit the GO button, a project selector overlay is displaying - after select a project you will see a preview result - this way you can check the result before you use the Report in project context.


Show Ancestor and Descendant Items

From codeBeamer 9.4.0 you can include ancestor (parent) and descendant (child) items of the result if only one tracker is selected in the Report (the same way as in the Filter widget of the Table/Document Views). To include ancestor and/or descendant items in a view, select one of the checkboxes when running a Report.

Please note that if you switch on any of these settings, Grouping and Ordering will be disabled.

Result table

The result table contains the Tracker Items which are matched to the set filter options group by and order by according to the set values. The result table appears:

  • in View mode always during page loading
  • in Edit mode if you load an existing report during page loading
  • in case of new report, after clicking on GO button

In Edit mode you can modify the table layout:

  • you are able to reorder the table columns, by drag&dropping the table headers (a green line will help you during dragging where you can move the field) or by using the Move left and Move right options of the context menu near the column header name
  • you can remove column by using the Remove column of the context menu near the column header name
  • you can add more fields (as column) by drag&dropping from the left side tree (light green highlighting and a green line will help you during dragging where you can add the field). It is not possible to add field to the table if it already contains the field.
  • if the report is a grouped report and you added number type fields to the table, you can add summarize options and set formatting options (see below)

If you save the report, the table layout settings (columns, column order) will be saved also.

Adding Shared Fields

From codeBeamer 10.1 you are able to add Shared fields to the Result table. Use the Add Column context menu of the table header or drag&drop from the left tree as you do with normal fields. Please note that if you select trackers, only those Shared Fields will be displaying which are in use in the selected trackers.


Once you add a Shared Field to the Result table, the values of the custom fields (which are assigned to a Shared Field) of the proper tracker will displaying. If the Shared Field you added is not used in a tracker, you will see an empty column. You can use also inplace edit to modify the values and you can use all of the actions what you can use in case of a normal field (drag&drop, move left/right, delete).

Shared Fields will be also stored to the layout if you save the Report.

Summarize options

Summarize options are available only for grouped reports, using this functionality the number type field values will be aggregated per groups.

Use the context menu near a number type column (field), and choose Summarize, a small overlay will be displayed. You can select which type of aggregation functions you would like to see of the current field: sum, average, min and/or max. After clicking OK, the group headers will contain the aggregated values below the proper field. This functionality is working also by setting multiple group by options.

If you save the report, the set Summarize options will be saved also, after reloading the saved report, these values will also appear.

Formatting options

Formatting options are available only for grouped reports, using this functionality the number type field values will be shown as you set.

Use the context menu near a number type column (field), and choose Formatting options, a small overlay will be displayed. You can select format type (Decimal or Percent) and Decimal places (0-3). After clicking OK, the values of the selected field (also the group headers aggregated values if Summerize options set) will be in the same format which you set.

If you save the report, the set Formatting options will be saved also, after reloading the saved report, the values will appear as you set.

Advanced mode

Next to the Go button you can switch to Advanced mode. Using the Advanced mode, you can see only the sytax highlighted cbQL of the report, the project/tracker selector, filter list, group by and order by areas disappear, and an editable textarea appears. Note: if you use AND/OR Logic, the cbQL is not editable!

Advanced mode is for supporting some cbQL functions which are not able to use currently in Simple mode (e.g. escalation type cbQL functions) and for more complex AND/OR/NOT logic, but if you prefer cbQL language instead of drag&drop UI, you are able to create your own cbQL here. You can switch back to Simple mode, only if the Simple mode supports the typed cbQL, the cbQL is not too complex logically, it is valid and syntactically correct, unless you get a warning message, and you remain in Advanced mode.

If you save your report from Advanced mode, the report will be marked as advanced, so after load the report, Advanced mode will be the default mode.

Traceability Report

Since Codebeamer release HUSKY, the Traceability Report option is available on the Reports tab.

The Traceability Report operates in the same way as reports work in general. For details, see Traceability Browser and Tracker Views.


In Traceability Report, the columns can be resized by selecting the pixels checkbox as Resizable Columns setting.

The percentages option is not supported in the Traceability Report. When switching from Simple Report to Traceability Report with the percentages option selected, the Resizable Columns setting is cleared, and the percentages checkbox is not displayed. Switching back to the Simple Report, the percentages checkbox is available and selected again.


The Resizable Columns function can be configured globally in the "query" section of the Application Configuration:

"query" : {
  "columnResizeType" : "PIXELS",
}




If the column resize type is set to "PIXELS" globally, only the pixels option is available for all columns and levels of the Reports, Traceability Reports, Tracker Views and in Traceability View.

If the column resize type is set to "PERCENTAGES" globally, the percentages option is not available in Traceability Report.


With the pixels option configured, adjusting the width of the columns is not limited. Different column widths can be set for all the various columns on all levels in Traceability Tree View and in Hierarchical Table View as well.

In Hierarchical Table View with multiple levels, modifying, for instance, the width of the Summary column on Level 2, the resizing of the Summary column on Level 2 is synchronized in all the other tables, as in Intelligent View.


The Traceability Reports can be saved with the resized column widths, therefore, the same settings are returned when loading the report.


See also: Widgets


Export Report to Office

Reports can be exported to Excel. Two options are available:

  • Simple export: export with the columns which you see on screen (saved for the report)
  • Export via template: in this case you have to select first a project which contains existing template or you can upload one.



From codebeamer 21.04 a new option is available while exporting result to Excel: Multi-values go to multiple rows. If this option is checked, a reference or member field values will be exported in separate rows, otherwise the vlaues will be exported in one cell in a comma separated list.

Report Jobs

From codeBeamer 8.1 you are able to send automatic reports by email on a regular basis.

New Job

Every user can create an own Job for an own or shared Report. Open a Report and click on New Job within the action bar.

Settings of the Job:

  • Name: mandatory field, by default the name of the Job will be the name of the Report.
  • Recipients: who will recieve the emails
    • Personal subscription: only you will get the email
    • Project roles: If the Report is shared with some roles, you can select here these roles too. In this case there is a restriction, the first 10 user/role will get the email.

  • Threshold: the email will send only if the report contains more item than the number set here.
  • Frequency:
    • Daily: once per day or every 4 hours a day starts at a specific time (hour).

    • Weekly: you can select on which day(s) of week should the email to be sent. The sending time within the day can be set the same way like the Daily option.

    • Monthly: specific day of every month or specific day of week of every month. The sending time within the day can be set the same way like the Daily option.

Please note, that emails will be sent according to the user's timezone and the exact time of email sending will depend on job queue activity.

Manage Jobs

Clicking on Manage Jobs on the action bar, you can see a list of your own Jobs. Each Job can be edited, disabled/enabled or deleted. Disabled Jobs are grayed out.

Administrate Jobs

System administrators can manage (edit, disable/enable, delete) all of the Jobs under Job Manager of System Admin pages, furthermore they can see other information of each Job (Status, Last Run, Created at, Owner, etc.).

Drill Down into Trackers

Since Codebeamer release HUSKY, the Drill Down into Tracker feature is available on the Reports page.


The feature is linked with the Page View. To be able to use the Drill Down into Trackers feature, Page View must be enabled in the Application Configuration:

"pageView" : {
        "disabled" : false
    },


If Page View is enabled, the Drill Down into Tracker feature can still be enabled or disabled separately in the Application Configuration:

"drillDownIntoTracker" : {
        "disabled" : false
    },


Enabling the Drill Down into Tracker feature is not considered if the Page View is disabled.


The Drill Down into Tracker feature can only be used if a report is grouped by Trackers. For this, click Add in the Group by section on the top right, and select the Tracker grouping option.

After clicking GO, the Open in Table View link is displayed next to those trackers for which Table View is available, and for which the user has the proper permissions.


Clicking the Open in Table View link next to the relevant tracker opens the tracker in Table View regardless of what the default view for that tracker is. Any filters, AND/OR logic, Group by, Order by options applied on the Reports page are transferred to Table View if that filter, logic or order option is applicable in the related tracker.


Warning messages are displayed when any of the applied settings cannot be transferred and applied in Table View. Such cases are:

  • A filter, logic or order option is not available in Table View for the selected tracker, and that setting is not transferred and applied in Table View.
  • The user wants to jumps to a tracker in which the relevant field or filter is not defined, even if that field or filter is used with the Add Filter, Group by or Order by logic, or is used as a column in the table header.
  • The relevant filter cannot be transferred and applied in the target tracker due to permission issues.
  • The used AND/OR logic is not transferred when the user is redirected to the target tracker. These need to be modified in the target tracker.

The warning messages can be enabled or disabled in the user Preferences > REPORT / TRACKER VIEW SETTINGS by selecting or clearing the Show warnings when navigate from Report page to the Tracker page. checkbox.

If the warning messages are turned off by using the related checkbox within the displayed warning messages, the Show warnings when navigate from Report page to the Tracker page. checkbox gets disabled in the user Preferences.


Limitations:
  • The Drill Down into Tracker feature is only available on the Reports page.
  • The Open in Table View option is not available for trackers where Table View is not supported.
  • The Drill Down into Tracker feature is not available in Expert Mode.