5.1.4.4. Issue Table and Issue Deltas

In the Issue Table view, each table row represents an Issue. The details of an issue (i.e., source code, explanations, timeline, and annotations) can be opened by clicking on the table row.

Note

Since dashboard version 7.3.0, a left-click on a row’s content no longer opens the details in a new tab. This can still be achieved by using the middle mouse button or Ctrl + Shift + left-click to open it in an active tab.

Issue Table showing issues removed and added between two versions.

Issue Table showing an issue delta.

Table Columns

Each of the six Issue Kinds has its own specific table columns. However, some columns are common to all issue kinds; these are described below with hints to help users understand them.

See here for the complete list of common and issue-kind-specific columns from a technical perspective.

Id

Every issue has a kind-unique ID that can be used to quickly access the issue via the navigation bar.

State

Indicates whether an issue was Added or Removed relative to the current Version Selectors. See also the related State Selectors.

Suppressed

Indicates whether or not an issue should be hidden by default in the Dashboard. See here for more information.

Error Number

Some, but not all, issue kinds have an Error Number referring to the Rule that detected them. This is most commonly used to divide large numbers of issues into smaller groups with similar properties.

Path

This column name varies slightly depending on the issue kind, and there may be more than one path. Generally, it refers to where in the source code the issue was found. Note also the special Path Filter that simplifies the common use case of filtering by source location.

Owners

Dashboard users associated with the issue in various configurable ways. These are filterable via the User Selector. See here for more information.

Justification

A short text describing why an issue is tolerated instead of being fixed. See here for more.

Tags

A special type of Issue Annotation.

Risk ranking columns

Up to five configurable columns with scores between 0.0 and 1.0 that together express the risk of an issue. See here.

Table Menu

The Issue Table offers several operations on its content, which can be accessed via the Menu Button dashboard2-uiicon-menu in the upper-left corner of the table.

The Issue Table Menu and its options.

The Issue Table Menu.

Add / Remove tags

Allows you to add or remove Tags from all selected issues.

Show columns

Allows you to toggle the visibility of specific Table Columns.

Download CSV

Allows you to download the currently shown issues as a CSV-file.

Download JSON

Allows you to download the currently shown issues as a JSON file based on this schema.

Issue Kind Selector

You can select the issue kind you want to inspect using the Issue Kind Selector in the upper-left corner of the toolbar.

As mentioned previously, each of the six issue kinds has its own specific table columns; therefore, when you choose a different issue kind in the Issue Kind Selector, the table columns will change along with the table contents.

Note that some of the Issue Kind icons are colored red. This indicates whether there may be added issues for the selected kind in the current version selection.

In addition to the Issue Kind Selector, there are other controls you can adjust to influence which issues are displayed and how they are shown.

Version Selectors

The Issue Table has two main modes:

  • View issues in an analysis version

  • View issues added and removed between two analyzed versions (aka Delta)

You can switch between these modes using the left version selector. If it is set to EMPTY, you will see the issues active in the version indicated by the right version selector. Otherwise, you will see the issue delta: issues that exist in the right version but not the left, as well as issues that existed in the left version but no longer exist in the right.

State Selectors

The two arrow symbols in the toolbar can be used to show only Added dashboard2-uiicon-added or only Removed dashboard2-uiicon-removed issues.

In both cases, they display the total number of Added and Removed issues for the current filter settings. Note that when not viewing a delta (i.e., the left Version Selector is set to EMPTY), there will never be any Removed issues, and all issues are considered newly Added.

User Selector

With the User Selector, you can specify whose issues you want to see. The following options are available:

  • ANYBODY: does not filter,

  • NOBODY: shows issues not associated with any VCS user,

  • <username>: shows issues owned by the given dashboard user,

  • <username> (public): shows issues owned by the given public dashboard user,

  • <username> (unmapped): shows issues owned by no dashboard user but associated with the given VCS user.

You cannot filter by any dashboard users other than your own or public users unless you have the required permission.

Column Filters

Column filters are expressions you can enter to filter for specific entries in the associated issue cells.

A column filter example.

A column filter example.

Simply put, filter expressions are case-insensitive substring filters that accept * as a wildcard; they also support logical combinations. Consult this for advanced use cases or check out the Filter Assistant.

Column Sorters

You can sort the table by most of the available table columns. To do this, click the small sorting icons displayed on the sortable columns. Multiple clicks will alternate between the available sorting modes for a column. To sort the table by multiple columns, shift-click the sorting icons in order from the most important to the least important column.

Path Filter

The Path Filter is a special Column Filter that automatically filters all columns containing filesystem paths at once.

A path filter example.

A path filter example.

Filter Assistant

When filtering across many columns, there is an alternative way of providing filter expressions that is particularly useful when filtering for multiple, possibly very different column values – for example, different Error Numbers that should be prioritized. It displays a List of available choices to choose from and allows combining them to filter for multiple exact values at once. As the List of available choices can be quite long, it can also be filtered with a simple substring filter.

The multiple choice column filter assistant.

The multiple choice column filter assistant in action.

Named Filters

Filter configurations can be persisted to help establish predefined workflows using so-called Named Filters.

CSV Download

Issues matching the currently selected criteria can be exported as a CSV file (e.g., for post-processing in Microsoft Excel) by clicking the Download CSV option from the Table Menu. You may need to configure the CSV separator character, as the correct one cannot always be determined automatically.

Administrators can also configure the global preset for this user-specific configuration option. They also have the option to enable a special CSV header explicitly specifying the separator to use at the beginning of the file. This option is disabled by default as it is non-standard and currently only supported by Microsoft Excel and newer versions of LibreOffice.