There are two ways to add a new Metric Suite to your model:

  • Create a Metric Suite using the BaseMetricSuite (recommended).
  • Create a Metric Suite from scratch.

The BaseMetricSuite is a predefined Metric Suite stored in the DSL Customization profile of the UML Standard Profile.

You are free to choose either way, but we highly recommend the first one. It aids the creation of a new Metric Suite, which inherits the BaseMetricSuite attributes that are necessary for calculating metrics (e.g., the context parameter definition and the metric definition for date tracking). This way you don’t have to specify them on your own.
 

To create a Metric Suite using the BaseMetricSuite


  1. Make sure that your project uses the UML Standard Profile. If not, use it by going to Options > Project Usages.
  2. Create a Package to store all the Metric Suites of your model.
  3. In the Package, create a Profile Diagram. If you can't find it in the list of available diagrams, enable the Expert mode.
  4. Press Ctrl+Alt+F and in the Quick Find dialog type “BMS”. 

    Make sure you clear the Apply Filter check box.

  5. Click the BaseMetricSuite in the list of search results. The BaseMetricSuite is selected in the Containment tree.

  6. Drag the BaseMetricSuite from the Containment tree to the diagram pane. Its shape appears on the diagram.

  7. In the diagram palette, click MetricSuite, and then click a free space on the diagram. A new metric suite is created and its shape appears on the diagram.

  8. Create a Generalization relationship from the newly created Metric Suite to the BaseMetricSuite.

Now the newly created Metric Suite inherits all the parameter and metric definitions of the BaseMetricSuite.
 


To create a Metric Suite from scratch


  1. Create a Package to store all the Metric Suites of your model.
  2. In the Package, create a Profile Diagram. If you can't find it in the list of available diagrams, enable the Expert mode.
  3. On the diagram palette, click MetricSuite, and then click a free space on the diagram.

A new Metric Suite is created and its shape appears on the diagram.
 


To specify the description of a Metric Suite


  1. Double-click the shape of a Metric Suite to open its Specification window.
  2. Click Documentation/Hyperlinks on the left side of the window.
  3. In the text box on the right side of the window, type the description.
  4. Click Close.