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

codebeamer Application Lifecycle Management (ALM)

Scheduled maintenance 2023.06.01. 07:30 CET

Search In Project

Search inClear

Tags:  Excel Export Report

Reports (Vintage)

Reports help to assess the states of projects, tasks, bugs, requirements and other data available in the trackers. The output of the reports can be exported into a large variety of formats. Exports can be made with comments, associations, children, descriptions and state change history. CMDB configuration items can also be used to generate reports.

For advanced reporting see You must login to see this link. Register now, if you have no user account yet..

Clicking the Reports tab will display the list of all permitted reports.

Reports contain only data which you have permission to read. The same report started by other users having different permissions might produce different results.

Figure: Report List.

Running Reports

To run a report click on the associated Runlink in the tool-tip. After running a report, the result can be exported into Excel, PDF, CSV, XML and wiki formats.

Figure: Report Output.

Exporting Report Data

To export report data, run a report and click on Export when it finishes, or click Export on the report's tool-tip menu in the report list. Exported data can include comments, associations, children, descriptions and history.

Figure: Report Export Formats

Creating Reports

The ad-hoc report editor can be used to edit reports.

To create a new report:

  1. Click on the Reports tab,
  2. Click on New Report to start the ad-hoc report editor wizard.

Creating Simple Reports

The simple report editor wizard allows the creation of reports that contain one table for each tracker. The first menu allows the user to select the input, which is either Trackers or CMDB items, and the output format, which is either a separated results list over all trackers or categories, or a merged list.

In step 2 of the simple report wizard all the visible projects are displayed and the user can select those projects whose trackers should be used for the report.

Step 3 of the simple report wizard shows the list of visible trackers from the previously chosen projects. Simple reports can be created for one or more trackers. The trackers may belong to different projects, if more than one project was selected in step 2.

Figure: Ad-hoc Report editor wizard (1).

Figure: Ad-hoc Report editor wizard (2).

Creating Merged Reports

The merged report wizard allows the creation of reports that present the tracker issues of all selected projects in a single unified tabular layout. A merged report generates a table where all the tracker issues are shown together. The tracker issues are not sorted by tracker, but rather are sorted based on user specified filtering, display and sorting criteria.

The difference between the simple and merged report wizards is the layout options in the last step (Step 5). Step 5 of the merged report wizard allows the definition of the following reporting criteria:

  • Filtering - This operation is available for non-member, non-time-date fields like Priority, Status, Detected or Target, or other common fields selected using the Add Custom Criteria link, or a specifically defined SQL field definition. The Status and Priority filtering values are selected from a merged set of all choice values from the selected trackers. Values can be reverse-value selected using a logical NOT as well. The Detected and Target release field-filtering have pencil-icon links, that bring up lists of releases to select, that is a reference field. Please note that some of these fields might not be available for the merged report if the user does not have the correct permissions in any of the selected trackers.
  • Displayed Fields - Since the trackers in merged reports may have different sets of field names, the list of selectable fields is made up only from the common set of fields for the selected trackers. This set is constructed based on case sensitive comparison of the field names. Fields with the same name don't have to have the same type.
  • Sorting - The values of the report can be sorted based on a combination of the available fields. The sort direction can be altered by checking the Ascend check box.

There are two additional fields that can be used for display and sorting in merged reports: Project and Key. The Project field represents the CodeBeamer project the tracker belongs to. The Key field is the internal tracker key in the system.

Embedding Reports into Wiki pages

Reports can be embedded into Wiki pages using the Report Wiki plugin.

The Wiki plugin

[{Report id='22556'}]

will result in:

Report plugin failed: Could not find plugin Report
(com.ecyrd.jspwiki.plugin.PluginException:Could not find plugin Report, java.lang.ClassNotFoundException:Class 'Report' not found in search path!)

Tracker Item State History Report Plugin

The TrackerItemStateHistory Wiki plugin shows the state change history of a issue (bug, task, etc.), identified by its task-id (click here for more details).

The Wiki plugin

[{TrackerItemStateHistory id='35941'}]

will result in a list of the issue's history changes

TrackerItemStateHistory plugin failed: Can not find task with id=35941
(com.ecyrd.jspwiki.plugin.PluginException:Can not find task with id=35941)

Edit a Report

Editing an existing report is possible only if your user group permissions allow it.

To edit a report:

  1. Click on the Reports tab,
  2. Click on a report's Customize tool-tip link,
  3. complete the ad-hoc editor wizard, just like creating a new report.

Deleting Reports

Delete reports when they are no longer needed.

To delete reports:

  1. Click on the Reports tab,
  2. Select the reports that need to be deleted,
  3. Click the More Actions... and Delete... tool tip button and confirm the action in the message dialog.

Report Permissions

Permissions control who can run and customize a report on a project role basis.

To set the permissions of reports:

  1. Click on the Reports tab,
  2. Select the reports for which to change the permissions,
  3. Click the More Actions... and Permissions... tool tip button,
  4. Set the Run and Customize check boxes for each role,
  5. Press the Save button.