Customizable Defect Reports

Applies to Collaborator 13.4, last modified on January 18, 2021

This group of pre-built reports generates a list of defects that meet certain requirements. Currently it includes the following review list reports:

  • All Defects - List of all defects from all reviews.

  • My Recent Defects - List of defects you created recently.

  • My Open Defects - List of defects you created and that are still open.

Once you click on a report name, you will be directed to a page where you can configure the criteria for the defect reports.

This documentation uses the default names of defect fields, columns and options. On your Collaborator server this information may vary, depending on server configuration: display labels, role names, review custom fields and so on.

The options are divided into several groups: Columns, Filters and Options.

Columns

In this section you can select which of the fields to include in the generated report. Thus you can choose how much or how little you view in the report.

Typically the following column names are displayed:

Defect ID

The unique identifier of the defect.

State

The state of the defect: Open, Fixed or Tracked Externally.

Review ID

The unique identifier of the review to which the defect belongs.

Review Title

The title of the review to which the defect belongs.

Review Group

Name of a group of users associated with the review.

Review Creation Date

Date and time, when the review was created.

Review Completion Date

Date and time, when the review was finished. Empty for in progress reviews.

Created

Date and time, when the defect was created.

Creator Login, Creator Full Name

The login and full name of a person who created the defect.

File

Full name of a file to which the defect belongs.

File Version

The ID of file revision where the defect was found, or "unversioned" if the file is not under SCM.

Changelist ID

The ID of a changelist that contains the file where the defect was created. Empty if the file is not under SCM.

Changelist Date

Date and time, when the changelist was created.

Changelist Author

Name of a person who uploaded the changelist.

Changelist Comment

The comment of a changelist.

SCM Type

Type of a version control system.

Location

Location for context specific defects.

LocatorType

Type of the defect: Global, Annotation, Overall for File Revision or URL, Line, Coordinate, Label, Cell. See Types of Review Comments and Defects

Comment

Comment that relates to the defect.

External Name

Name assigned to the defect in the external issue tracker system.

Severity

Indicates how critical the defect is.

Type

Indicates the type of found defect.

<Defect Custom Field>

Value of any other defect custom field.

Filters

In this section you can define which defects to include or exclude from the report. Most of the fields that Collaborator can display (see Columns section), can also act as filter fields.

You can specify one or more conditions and Collaborator will show only those reviews that match these criteria. For instance, show defects in some particular state, defects created in certain time period, defects whose comment contains particular word and so on.

When several conditions are given, the report displays data that matches all of the specified conditions.

Options

In the Options section you can specify how the found data is sorted, entitled and divided into pages. A report has a limit on the maximum number of rows that can be displayed: 50 rows by default. You can change the number in the Max # Rows field. When you export report data to CSV or SQL or print the report all rows are exported/printed regardless of this option value.

Generating Reports

To generate any report from this group:

  1. Choose the type of a report that you need and click its name.

  2. Specify the desired options for the report: column set, filters, sorting and so on. To reset the report options and filters, press Revert button.

  3. Click Run button to generate the report with the specified criteria and parameters.

The report will be displayed in the Results pane in the bottom of the page.

Exporting Reports

To export any report from this group:

  1. Generate the desired report as described above.

  2. Click one of the toolbar buttons in the top right of the Results box:

    • The Link button will bring up a pop-up window with a direct link to the current customized report (with all the current options and filters preserved). You can bookmark this link to use whenever you want to revert back to the review configuration.

    • The SQL button will display an SQL query that was used to generate the current report. You can use this SQL query when creating custom reporting tool. This button is not available to regular users, unless the Reports access setting is set to Enabled for everyone.

    • The Printable button will prepare the report in a printable format.

    • The PDF button will export the report in PDF format.

    • The CSV button will export the report in comma-separated values format. Note the CSV output format does not consume a license.

    • The XLSX button will export the report as Excel spreadsheet.

    • The DOCX button will export the report as Word document. (Due to report engine implementation, generated documents are compatible with Microsoft Word and Google docs, but could be incompatible with OpenOffice and LibreOffice.)

See Also

Reporting
Review Chats, Comments, and Defects

Highlight search results