5.1.4.8. Issue Annotations¶
The Issue Annotations feature allows users to annotate issues, creating
customized review and issue-handling workflows. Issue annotations primarily consist of Tags
and Comments that can be attached to issues after analysis is completed.
The Issue View showing annotations¶
The Issue View sidebar contains an
annotations panel used to associate plain-text Comments and, more importantly,
Tags with issues. These Tags can later be used as a filter
criterion in the Issue Table.
Note
To view issue annotations, the corresponding project-specific
permission is required. To change Tags or write Comments, another
project-specific permission is required.
Three additional related permissions exist: one to create new tags and access
Tag Management, one to delete
Comments made by other users, and Low-Level Issue Annotation
Control, which allows creating annotations on behalf of other users (e.g., when
merging annotations from another project).
The Issue Table showing some tagged issues¶
In addition to filtering by an issue Tag or a combination of tags, the Issue
Table allows users to select
multiple issues and add or remove one or more tags for all selected issues
simultaneously using the leftmost column and the hamburger menu in its header.
Caution
Issue annotations may be lost if analysis configuration errors occur; the logic that links current issues with previously identified ones cannot determine whether an issue was missing due to configuration changes or if it was actually resolved. If configuration changes were accidental, it may be preferable to delete the incorrect analysis versions.
Linking with JIRA Issues¶
If configured, a special annotation type allows linking Dashboard and JIRA issues bidirectionally; the Dashboard issue links to the JIRA issue and vice versa.
Depending on how the Dashboard Administrator
configured the JIRA integration, users
may need to create a
JIRA Access Token before creating these links.
This JIRA Access Token is stored within the Dashboard configuration and is only
usable by the user who created it. The Dashboard user interface guides users through this process.
The Issue Annotations Panel with active JIRA integration¶
Once set up, the Issue Annotations panel can be used to link existing
JIRA issues and provides a shortcut to create new JIRA issues
from an existing Dashboard issue. Newly created JIRA issues must still be
linked manually.
Disabling Issue Annotations¶
Administrators can disable the Issue Annotations feature on a per-project basis and configure whether the feature is enabled by default for new projects.
When the feature is disabled, the Tags columns are removed from
the Issue Table and the Annotations Panel is removed
from the Issue View.