Adding comments to artifacts in a module

A comment is a textual discussion item that you can add to an artifact in a module. You can use comments to provide team feedback during the development of a module, and can direct comments to other team members.

About this task

When you add comments to an artifact in a module, the comments appear in the artifact comments sidebar, which you can view in the sidebar one artifact at a time. However, if you add the Comments column to your display settings, comment icons are displayed next to all the artifacts in the module that have comments. These icons indicate the state of the comment. You can hover over a comment icon to display a hover window in which you can either view the comment, create a new comment, or show all the comments for the artifact. The following table describes the comment icons that can appear in the Comments column:
Table 1. Comment icons that can appear in the comments column
Comment Icon Description
recent comments icon Indicates that there are one or more recent comments and one or more unresolved comments. A recent comment is a comment that was created, modified, resolved, or reopened within the last 14 days.
Note: You can modify the duration period for comments on the server, in the teamserver.properties server configuration file. You can also modify this configuration property to specify which comments to display in the Recent Comments widget.
new but resolved comment icon Indicates that there are one or more recent comments, but that all comments are resolved.
Indicates that there are no recent comments, but that some comments are still unresolved.
resolved comments icon Indicates that there are no recent comments, and all the comments are resolved.
no comments icon Indicates that there are no comments. This icon appears when you hover over a row. You can click this icon to add a new comment to the artifact.
To add a comment to an artifact in a module:
  1. Click the artifact menu edit and then click Comments > Create comment for this artifact.
    Tip: You can also add a comment by hovering over a row and clicking the no comment icon .
  2. In the Create Comment for Artifact window, enter subject and comment text.
  3. In the Directed To field, search for and select the user to whom to direct the comment.
  4. From the Priority list, select a priority.
  5. Click OK. Your comment appears in the Artifact Comments section of the sidebar.
To show the comment for an artifact, click the artifact menu edit and then click Comments > Show comments for artifact. The comments appear in the sidebar.
To see all of the artifacts in the module that have comments, add the Comments column to the module. To add the Comments column:
  1. Click the Configure Page Settings icon Configure Page Settings icon and then click Configure Columns to Display.
  2. In the Change Column Display Setting window, add Comments to the Columns to Show field and then click OK.
    Tip: You might want to save your changes as a view to make it convenient to return to this display setting.

If there is a recent comment for an artifact, the recent comment icon appears in the Comments field:

artifact with recent comment icon
If you click this icon, all the comments for the artifact are displayed in the sidebar; however, you can also hover over the icon to display the most recent comment that was made for the artifact:
comment hover text
From the hover window, you can create new comments or show all the comments for the artifact.

Sorting comments

To sort the Comments column, click the top of the column. When you sort the column, artifacts are displayed in this order: artifacts with recent comment activity (indicated by the recent comments icon and new but resolved comment icon icons from Table 1), artifacts with recent comments, artifacts with unresolved comments, artifacts with resolved comments, and artifacts with no comments.


video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki