On this page

When publishing a Cameo Collaborator document, you can choose to save Cameo Collaborator comments as model elements in a project. This allows you to work with them as any other UML elements and use the benefits of the modeling tool functionalities, such as calculate metrics, validate comments, and create comment reports.

Synchronization between a project and a document

When Cameo Collaborator comments are saved in a project, they are automatically synchronized between the project and a document every time you commit changes to the server or update the project.

Synchronized projects

Synchronized projects on the target Magic Collaboration Studio server are read-only. This means you cannot create comments or modify such projects in any other way. Learn more about cross-cluster resource synchronization.

Creating Cameo Collaborator comments and replies

You can create textual Cameo Collaborator comments and replies either directly in the diagram where the commented element is displayed or in the Containment tree.


To create a Cameo Collaborator comment in a diagram

  1. Open the diagram where the element that you want to create a comment for is displayed.
  2. In the diagram palette, click Collaborator Comment and click anywhere on the diagram pane to create a comment.
  3. Enter comment text on the shape of the comment and click anywhere on the diagram pane to save it.
  4. Create an Anchor from the comment to the commented element.

  5. Find the new comment in the Containment tree of your project and move it to the Package with the «CollaboratorComments» stereotype. This Package is typically named the same as the project.

    Collaborator Comments Package

    If this is the first Cameo Collaborator comment created in the project and the Package with the «CollaboratorComments» stereotype does not exist, create a Package dedicated for comments and apply the «CollaboratorComments» stereotype to it. Then place the newly created comment in this Package. All Cameo Collaborator comments must be stored in such a Package to be valid and visible in a published document.

The Cameo Collaborator Comment will be visible in a published document once you commit changes to the server and refresh the document. If you want to create comments in the Containment tree of your model, you can do it as described below.


To create a Cameo Collaborator comment in the Containment tree

  1. In the Containment tree of your model, right-click the Package with the «CollaboratorComments» stereotype and select Create Element > Comment.

    Collaborator Comments Package

    If this is the first Cameo Collaborator comment created in the project and the Package with the «CollaboratorComments» stereotype does not exist, create a Package dedicated for comments and apply the «CollaboratorComments» stereotype to it. All Cameo Collaborator comments must be stored in such a Package to be valid and visible in a published document.

  2. Type the text of the comment and press Enter.
  3. Right-click the created comment and select Refactor > Convert To > More Elements > Collaborator Comment.
  4. Open the Specification window of the new Cameo Collaborator comment, and select the specification cell of the Annotated Element property, and click .
  5. On the left side of the Select Elements dialog, select the element the comment is created for and click  to add it to the selected elements area.
  6. Click OK and close the Specification window.


This figure demonstrates how Cameo Collaborator comments look like in a diagram and in the Containment tree.