Working with Comments

About Comments

Use the Comments pane in the Workflows and Activities category views to share information about a workflow or activity with other users, or to make notes.
The Comments pane enables you to add new topics or reply to an existing topic that is associated with a workflow or an activity. You can also search, sort, or filter the comments.
You can add multiple comments to an activity or workflow. Each comment becomes its own topic, to which other users can reply. The original comment and its replies are a topic thread. Each entry in the topic thread includes the user ID of the person who created it, and the date and time when the comment or reply was last modified. Topic threads are separated by lines in the Comments pane.
The following table describes the items in the Comments pane. Before you add a comment, only the New Topic button is available.
Plan Comments Pane Items
Item
Description
Search box
Enables you to display all topics that contain a specific text string.
Topic thread
Displays a comment and its replies, if any.
Topic threads are separated by lines in the Comments pane.
Actions menu
Provides options for sorting and filtering the entries in a topic thread.
Reply button
Displays a topic window in which you can enter a response to a comment or add a comment to the History Log topic.
New Topic button
Displays the New Topic window in which you can create a new comment.

Adding Comments

To add comments to a workflow or an activity, follow these steps:
  1. Select the workflow or activity.
  2. In the Comments pane, click New Topic. The New Topic window appears.
    New Topic
  3. Enter a topic name and a comment.
  4. Set the priority of the topic. The default is Normal.
  5. (Optional) Click Attachment to add a file with the new topic. For more information, see Attach a File.
  6. Click Save. The new comment now appears in the Comments pane.
    Comments Pane

Reply to a Comment

To reply to a comment, follow these steps:
  1. In the Comments pane, expand the topic thread to which you want to add a reply.
  2. Click Reply. A topic window appears. The title bar displays the name of the topic to which you are replying.
  3. Enter your comment in the box.
  4. Set the priority. The default is Normal.
  5. (Optional) Click Attachment to add a file to the new topic. For more information, see Attach a File.
  6. Click Save. The reply is added below the original comment.

Attach a File

When you add a comment or reply, you can include attachments. There are no restrictions on the types of files that you can attach, or on their size. However, including large attachments in a comment or reply can affect Workflow Console performance.
To add an attachment, follow these steps:
  1. Click the Attachment button in the Comment or Reply window.
    The Select file(s) to upload window appears.
  2. Using the Look in field, navigate to the location of the file.
  3. In the list, click the file that you want to attach. Its name appears in the File name box.
  4. Click Open.
    The topic window appears. The filename and size appear below the comment box.
    Note: Before you save a comment or reply, you can use the remove attachment button Remove attachment to the right of the attachment name to remove the attachment. After you save a comment or reply, you cannot remove its attachments.
  5. Repeat steps 1 through 4 to attach more files.

Sort and Filter Items in a Comment Topic Thread

Use the Actions menu to sort the comments and replies.
Comments Pane Sort Options
Option
Description
Sort by Date Ascending
Displays the comment and replies in ascending order by their date and time.
Sort by Date Descending
Displays the comment and replies in descending order by their date and time.
Sort by User Ascending
Displays the comment and replies in ascending order by user ID.
Sort by User Descending
Displays the comment and replies in descending order by user ID.
Show Only My Replies
Displays only the replies that have your user ID.

Search for Comments and Replies

For a selected workflow or activity, use the search box at the top of the Comments pane to find all the comments and replies that contain a specific text string.
To initiate a search, enter the text that you want to find in the search box and click Search button.
The application applies the search to all the topic threads, and divides the results into two categories:
  • Message Body: displays the topics that contain the search string in their comment text.
  • Topics: displays the topics that include the search string in their titles or comment text.
As shown in the following example, the search returns all of the topics that contain the string “workflow” and underlines the relevant area of text in the display:
Example of comment search
To clear the search and display all topics, click Return to Comments.
To display the full content of a topic, click Show This Topic. The application displays the original comment and all its replies.
After you review a selected topic, do one of the following:
  • To return to the list of topics that match the search criteria, click Back to Search Results.
  • To clear the search criteria, click Show All Topics.