Creating or modifying the content of a custom template

On this page

After creating the container for storing your custom template, you must create a Collaborator View Diagram and a Collaborator Viewpoint Method Diagram. In these diagrams, you can build the structure of the template and start defining its content. 

If you have already created both Collaborator View and Viewpoint Method diagrams, visit the following pages to learn about defining their content:

Creating a View Diagram
 

To create a View Diagram

1. In the model browser, select the package for storing the diagram you intend to create, and, in the main toolbar, click Create Diagram.
2. In the open dialog, select Collaborator View Diagram under the Cameo Collaborator group.
3. In the open text box, enter the diagram name.
    

The essential components of a View Diagram are Document, View, and ViewPoint. You can create them by opening the View Diagram, and using the diagram palette that is shown in the figure below on the left. SysML specification states that the view displayed in the View Diagram represents the system from a particular viewpoint, whereas, a ViewPoint is a specification of rules for constructing a view to address a set of stakeholder concerns. Each of these essential elements performs a different function within a template.

Document is the root element of a template. The name of the Document is also the name of your custom template, e.g., Usage cases. You can select this name in the Template box of the Cameo Collaborator Publisher dialog when publishing a project.

Selecting the custom Usage cases template in the Cameo Collaborator Publisher dialog.

View is a standalone description of the model within your template. In general, each view is used to display a certain type of information. You can create as many views as required. Different views not only display different types of information, e.g., requirements or use cases, but also create separate navigation trees (views) in a published project. Note that you can choose to have all of your views displayed in a single tree by enabling the Single Tree View mode.

The main properties of a View element are:

• Skip if Empty - if set as true, a published project does not display views without data.
• Document View - if set as true, this particular view of a published project is presented as a continuous document.
• Allow To Switch Property View Mode - if set as true, the mode of this particular view can be switched from Model View to Document View and vice versa. To change the mode when browsing a published project, open the view, click , and select Model View or Document View.
   

ViewPoint is used to define the rules that dictate how information is collected from the model and displayed on the web. Viewpoints are related to views through a Conform relation. The rules contained in a viewpoint are modeled in an activity-like form utilizing a special Viewpoint Method Diagram.

Creating a Viewpoint Method Diagram

To create a Viewpoint Method Diagram

1. In the model browser or in the View Diagram, select the element with the «Viewpoint» stereotype, and click Create Diagram in the main toolbar.
2. In the open dialog, select Collaborator Viewpoint Method Diagram under the Cameo Collaborator group.
3. In the open text box, enter the diagram name.

The figure below shows a basic example of a Viewpoint Method Diagram.
 

Viewpoint Method Diagram with predefined actions exposing paragraphs and images.

A Viewpoint Method Diagram has predefined actions. These actions are used to create the template that displays the model information in the web portal. Predefined actions can be grouped by their purpose:

• Collect model elements actions - collect various model elements according to different parameters.
• Filter model elements actions - filter model elements by specific criteria.
• Sort model elements actions - define the order of model elements.
• Presentation actions - define how the information is displayed on the web
• Table structure actions - create custom table templates, and export information into the table.
• Predefined template actions - display information in the specific way defined by the chosen template, e.g., the Paragraph action displays information as a paragraph, the Image action exports information as an image, the BulletedList action creates a bullet list.

Available predefined actions are located on the diagram palette on the left side of the diagram pane.
 

The diagram palette containing predefined actions available in a Viewpoint Method Diagram.

Related pages

• Creating the container for a custom template

Additional resources

• Webinar Creating Templates in Cameo Collaborator
• User Guide for Creating Cameo Collaborator Templates