Creating Cameo Collaborator comment templates

You can use the Profile Diagram to customize Cameo Collaborator comment templates according to your needs or specific project requirements. Add additional input fields and properties, such as version selection check boxes or a Jira issue input field, which users can see in the web interface comments panel.

To create a Cameo Collaborator comment template

---

1. Open the project where you want to create a custom Cameo Collaborator comment template.  
2. Create a Profile Diagram.
   

   To see the Profile Diagram option when creating a new diagram, click  at the bottom of the dialog to enable the Expert mode.

3. In the Containment tree, navigate to Project Usages > Model [Document View Collaborator Profile] > Document View Collaborator Profile > Stereotypes.
4. Find the «CollaboratorComment [Comment]» stereotype and drag it into the Profile Diagram you created.
5. Create a profile in your Profile Diagram.
   In this part of the process, with the «CollaboratorComment [Comment]» stereotype applied and an empty profile created, your diagram should look something like this:
   
   
6. Create a stereotype element inside the newly created profile element. This is the stereotype that defines your custom comment template.
7. In the name field of the stereotype, enter the name for your custom template. This name will be displayed in the Cameo Collaborator user interface when a user creates a new comment and selects a comment template.
8. Create a generalization link from the new stereotype to the «CollaboratorComment» stereotype. The metaclass of the new stereotype changes to Comment:
   
   
9. Click the Create Property button to add a property. Supported property types:
   

   Type	Multiplicity	Result
   String	0	Not required
   String	0..1	Not required
   String	0..*	Not required
   String	1	Required
   String	1..*	Required
   String	Default	Required
   Boolean	-	Shown
   Enumeration	0	Not shown
   Enumeration	0..1	List, value is not required
   Enumeration	0..*	Check box, value is not required
   Enumeration	1	List, value is required
   Enumeration	1..*	Not shown
   Enumeration	Default	List, value is required

   
   Explanation:
   • If you add a String type, it shows in Cameo Collaborator as an input field;
   • If you add a Boolean type, it shows in Cameo Collaborator as a switch (with a true/false value);
   • If you add an Enumeration type, it shows in Cameo Collaborator as either a selection list or check box(es), depending on the multiplicity.

10. Once you've finished editing the diagram, commit the project to the server. Now, users can use the template you created when adding comments in Cameo Collaborator.

Example
In our custom template, let‘s display check boxes with the label Version and the following values:
2024x 
2024x Refresh1
2024x Refresh2

and provide an input field for a Jira issue URL.

To do this, we need to create an Enumeration type element and set the check box values as its properties:

Then, we add a property, e.g. Version, to the «Project X custom comments» stereotype, set its type to Versions, and its multiplicity to 0..* to display check boxes.

To add an input field for a Jira issue URL, we add a Jira Issue URL property and set its type to String:

After we commit the project to the server, users can see the Project X custom comments template with check boxes and Jira Issue URL input field in the Cameo Collaborator web interface: