Adding Comments to Configuration

Adding Comments to Configuration

You can add comments to document workflows. There are two kinds of comments you can add:

  1. Agent Comments, the comment set to the agent node.

  2. Workflow Comments, the comment set to the entire workflow.

Agent Comments

Add agent comments by selecting the agent and clicking on the comment icon speech-bubble.png or right-clicking the agent and selecting Add Comment from the context menu.

agent_comment_menu.png
Add Agent Comments from the agent options
agent_comment_right_click_menu.png
Add Agent Comments using the context menu

Workflow Comments

Add workflow comments by right-clicking on the workflow editor, select Add Comment from the Context Menu.

wf_comment_right_click_menu.png
Add Workflow Comments using the context menu

Adding and Editing Comments

A Comment dialog pops up to allow you to enter your comment in single or multiple lines.

Click Ok to save the comment.

Click Close to discard any comment added.

The Remove Comment button will clear the entire comment from the dialog.

image-20250529-030106.png
Example of a comment with multiple lines

While in read-only mode, the Comment dialog can be used to view the full content of the comment, especially when the comments are too long to be seen entirely comment box on the workflow editor. See Adding Comments to Configuration | Comments Tooltip for more information.

Comments Tooltip

comment_tooltip_view.png
Mouse over the comment


An agent comment can only display a single line of comment. To view the full content, you can mouse over the comment and a tooltip will show you the full content. You can also view the full comment by opening the Comment dialog.

The same applies to workflow comments.

Info

A short comment will not have any tooltips as the entirety of the content is visible within the comment box.

Show or Hide Comments

To show Agents and Workflow comments, click on the settings icon on the visualization toolbar and check Show comments to reveal all comments that are present within the workflow template.

The settings to show or hide comments will only apply to your user account.

image-20250605-021857.png
Show or Hide Comments

When the comments are hidden in the workflow editor, the option to add, edit or view existing comments will not be available. The entire comment functionality is turned off completely.

To enable comments, you will need to enable Show Comments.

Printing

When printing a workflow, the comments will be shown in as in the image of the workflow above. And also as part of the description, as in the example below.

An example of a printout file that has been created from the workflow: workflowcomments.pdf 

Example of printout, the text part.