Tags:
not added yet
ReportsTable of Contents
Handling ReportsNew ReportBy 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, PropertiesWhen 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 ModeThere 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 ModeSince Codebeamer release HUSKY, the Direct Edit Mode allows the changing of the report settings without having to run the reports.
You can enter the Direct Edit Mode in two ways:
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 ReportsClicking 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 ReportUsing the context menu of the current report you are able to Delete Report. Edit ReportStructure of the screenThere are three main sections of the Edit screen:
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.
Project and Tracker selectorsThe 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 listThis 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 selectorsThe 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:
You also can use the Filter option inside these selector for filtering meanings / field values.
User fieldsFrom 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 versionsBy 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 fieldsBy selecting date conditions, you will see a small control box, in which you can set your date ranges. Three options are available:
Number fieldsYou 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 filteringFrom 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 fieldsYou 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 fieldsYou 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 fieldsYou 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:
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 AssociationHas 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
2. Filtering by Suspected References
3. Association type
Has Association ToThe 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
For more information on Suspected References, see: Document View for Requirements
4. Association Type
5. Please begin to type or click on the pencil icon to select one or more Work Items!
If no items are selected, this filter defaults to hasAssociation() in Expert mode.
Tag FiltersFrom codeBeamer 9.3.0, you can also filter work items using Tag filters. CodeBeamer supports the following types of tags:
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 FilterFrom 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 FieldsFrom 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 filtersFrom + 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.
IncludeFrom 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:
Historical FiltersFrom 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 filters have the following limitations:
Filtering by fields of Reference ItemsFrom codeBeamer 10.0.0 you are able to filter by attributes of Reference Items. You have to options under Filtering Refertence Items group:
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 optionsUsing 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:
Group by sectionYou 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 sectionOrder 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 valuesIn 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 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 LogicBy 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:
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.
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 functionalityFrom 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 ItemsFrom 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 tableThe 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 Edit mode you can modify the table layout:
If you save the report, the table layout settings (columns, column order) will be saved also. Adding Shared FieldsFrom 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 optionsSummarize 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 optionsFormatting 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 modeNext 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 ReportSince 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 OfficeReports can be exported to Excel. Two options are available:
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 JobsFrom codeBeamer 8.1 you are able to send automatic reports by email on a regular basis. New JobEvery 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:
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 JobsClicking 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 JobsSystem 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 TrackersSince 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 },
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:
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:
|
Fast Links
codebeamer Overview codebeamer Knowledge Base Services by Intland Software |
This website stores cookies on your computer. These cookies are used to improve your browsing experience, constantly optimize the functionality and content of our website, furthermore helps us to understand your interests and provide more personalized services to you, both on this website and through other media. With your permission we and our partners may use precise geolocation data and identification through device scanning. You may click accept to consent to our and our partners’ processing as described above. Please be aware that some processing of your personal data may not require your consent, but you have a right to object to such processing. By using our website, you acknowledge this notice of our cookie practices. By accepting and continuing to browse this site, you agree to this use. For more information about the cookies we use, please visit our Privacy Policy.Your preferences will apply to this website only.
Note that user-behavior analytics are being captured on this server for the purpose of improving the Codebeamer user experience.