Comments

How can I comment on a diagram?

In the opened diagram, you will find the Comment-button in the menu bar. By clicking on the Comment-button, the comment bar opens on the right-hand side. Alternatively, you can also open the Comments via the context menu. This appears by a right-click in the editor. In the comment bar you can now see comments, if already submitted.

The screenshot shows the "Comments" button in the menu bar.

Click on the green plus to add a new comment. An input field will open where you can enter your comment.

Here, the comment tab is displayed with options such as "Create comment".

Click Send and your comment will appear in the comment bar. In addition the submission date and the name of the commentator will be displayed.

The screenshot shows the input field of "Add comment"  in the comment bar and the further option "Send".

If you do not want to submit a comment, cancel the process with the ESC-key or a click on the comment bar outside the comment field.

Some users receive an e-mail notification of the new comment. This is described for each stage below:

  • Local workspace: No notification is sent here. Modelers can see comments in this stage, if they have checked out the diagram, and use them for example as a to-do list.

  • Public Workspace: A notification is sent to the Author and to users involved in the conversation.

  • Preview: A notification is sent to the Examiner and to users involved in the conversation.

  • Publication: A notification is sent to the user or user group mentioned in the attribute Responsible and to users involved in the conversation.

Note

Please note that you do not receive notifications about your own comments.

Note

Comments are dependent on the area. This is caused by different work statuses and versions in each area. For example, users in the publication can not see comments from the public workspace. Regarding allocation diagrams comments can always be seen. It does not matter if you are currently in an allocation diagram or the main diagram.

How can I comment on an object?

Objects can be commented independently in each version of a diagram. These comments are not diagram overlapping.

Right-click on the object you want to comment on. Select Comment in the context menu.

The option "Comment" in the context menu of an object is clarified here.

The comment window opens. Here you can see existing comments and Add a new comment.

The screenshot shows the input window for an object comment and the option "Send".

Confirm the entry by clicking on the Send-button. The comment will now be visible for other users with access to the current stage.

The window of an object comment and input field is displayed here.

If you do not want to submit a comment, cancel the process with the ESC-key or a click on the comment bar outside the comment field.

Some users receive an e-mail notification of the new comment. This is described for each stage below:

  • Local workspace: No notification is sent here. Modelers can see comments in this stage, if they have checked out the diagram, and use them for example as a to-do list.

  • Public Workspace: A notification is sent to the Author and to users involved in the conversation.

  • Preview: A notification is sent to the Examiner and to users involved in the conversation.

  • Publication: A notification is sent to the user or user group mentioned in the attribute Responsible and to users involved in the conversation.

Note

Please note that you do not receive notifications about your own comments.

Note

Comments are dependent on the stage. This is caused by different work statuses and versions in each stage. For example, users in the publication can not see comments from the public workspace.

How do I edit or delete a comment?

Diagram comments:

Open the comment bar and navigate to the comment you want to edit or delete. Afterwards, open the context menu of the desired comment.

The button "More options" of a diagram comment is displayed here.

Select the Edit or Delete entry if you want to edit or delete the comment.

Object comments:

Open the comments by right-clicking on the object and selecting the entry Comment.

The option "Comment" in the context menu of an object is clarified here.

Navigate to the comment you want to edit or delete. Select one of the appearing icons to Edit (pen) or Delete (trashcan) the comment.

The comment of an object is displayed here with the options to "Edit" and "Delete".

Note

Administrators and Editors are able to edit or delete all comments. All other user roles can use these features only for their own comments.

How can I see which objects have already been commented?

You can activate the comment marker in the local and public workspace. Open the comment bar by clicking on the Comment-button in the menu bar.

The screenshot shows the "Comments" button in the menu bar.

Select the button Show comments on objects.

The screenshot shows the "Show comment on objects" button in the comment tab.

A yellow flag with the number of existing comments appears at an object, if it has already been commented.

Here, the comment marker is displayed on an object.

Clicking on a flag displays the corresponding comments of an object.

The window of an object comment and input field is displayed here.

Similarly, the comments can also be hidden.

How can I delete all comments?

Navigate to the comment bar and open the context menu More options by clicking the three overlapping dots.

Here, the comment tab is displayed with options such as "Create comment".

Select the Delete all comments option.

The screenshot shows the option "Delete all comments" in the comment tab.

Afterwards a safety query appears, which you can confirm by clicking on Delete comments. In the displayed diagram all diagram and object comments are then deleted.

Note

Since comments are stage-dependent, deleting comments only refers to the currently displayed version of the diagram.