Collaboration

Comments

How can I comment on a diagram?

The Comments of a diagram are available in the Options for every diagram view.

The screenshot shows the option "comments" in the options menu.

By clicking on the Comment entry, the comment bar opens on the right-hand side. In the comment bar you can now see comments on the diagram on top - if already submitted. If comments on objects of the diagram are existing, they are grouped below.

The screenshot shows the input field containing a new comment and also the button "Add comment".

Click on the Enter comment to diagram field to write a new comment. Once confirmed by clicking the Add comment button, your comment will appear in the comment bar. Each comment is displayed with the submission date and the commentator’s name as a chip.

Alternatively, you can also add a comment to the diagram via the context menu. This appears by a right-click in a free space of the diagram.

The screenshot shows the context menu of a diagram opened at free space of the diagram. There is the entry "Add comment" in the context menu.

Choose the entry Add comment to enter and add a comment by a click on the equivalent button.

The dialog window with a new comment and the button "Add" is displayed here.

Some users receive an email notification of the new comment. This is described for each stage in the following:

  • 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 depend on the area. This is caused by different work states and versions in each area. For example, users in the publication cannot see comments from the public workspace.

Note

Please note that the comment function is available for both checked-in and checked-out diagrams.

You can edit or delete a comment by a click on the desired entry in the context menu of your comment.

The context menu of a comment is displayed here.

Warning

Deleting comments is done immediately when you select the function. You will not be asked for confirmation again.

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 comment on an object?

Objects can be commented on independently in each version of a diagram. These comments are specific to the diagram version and do not overlap across different diagrams.

Right-click on the object you want to comment on and select Add comment from the context menu.

The option "Add comment" in the context menu of an object is shown here.

A dialog window opens. Here you can Add a comment in the equivalent field and confirm by a clicking the Add button.

The screenshot the dialog window for an object comment with the button "Add".

If you do not want to submit the comment, cancel the process with a click on the equivalent button or outside the dialog window. Alternatively, you can use the ESC key.

After you confirm the process, your comment becomes visible in the comment bar for all users who have access to the stage. You can view the comment bar by selecting the Comments entry in the options. If a comment has been submitted for an object, the object’s name will appear in the bar, and you can view the comment by clicking on the name.

The screenshot shows a diagram where the comment bar is opened. In the comment bar, the comment group of an object is opened.

In case an object has already been commented, you can alternatively enter a comment in the corresponding field. Confirm the input by a click on Add comment.

The screenshot shows how to add a comment to an object in the comment bar.

Some users receive an email notification of the new comment. This is described for each stage in the following:

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

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

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

Note

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

Note

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

Each user can edit and delete his own comments. Furthermore, administrators can also make these changes to all existing comments.

Open the comments through the options. Navigate to the comment you want to edit or delete by clicking on the list entry for the corresponding object.

This screenshot displays a collapsed comment group of an object.

In the context menu you have the option to Edit or Delete the comment.

The screenshot shows an object comment and the related context menu with the options "Edit" and "Delete".

The editing needs to be saved to apply the changes.

Warning

The deletion of comments is executed right after you click this option in the context menu. You will not be asked for further confirmation.