The Project Options in Concept Modeler provides a Preferred annotation property option for the UML Comments or «Annotation»s in a model. This capability allows you to control which annotation property becomes the “special” MagicDraw comment providing documentation, when you enter text into the Documentation pane or create a new Annotation. It also allows the documentation to be included in the Natural Language Glossary. If the UML Comments and the «Annotation» Comments do not have annotation property value assigned (annotationProperty Tag from Specifications), they should be treated as if they have "Preferred annotation property" assigned from Project options.

Changing a preferred annotation property tagged value will cause the ownership of existing UML comments and «Annotation»s to change, for example:

  • Any UML comment and «Annotation» that was using the old preferred annotation will be moved from being owned by the annotated element to being owned by the next-higher package.
  • Any UML comment and «Annotation» that is using the new preferred annotation property will be moved to being owned by the annotated element.

Note

  • Changing the preferred annotation property tagged value of UML comments and «Annotation»s will change their ownership.
  • Changing in ownership causes a change in the Documentation pane (on the lower-left) and what shows up in the Natural Language Glossary because the first UML Comment or «Annotation» that is owned by an annotated element is considered “documentation” in MagicDraw.

If you do not select an annotation property tagged value for any UML comment or «Annotation» in your model, any time we export it to an OWL ontology, the Concept Modeler will use the preferred annotation property that does not have a tagged value, which is http://purl.org/dc/terms/description [3]. This preferred annotation property without a tagged value (unspecified) in the Concept Modeler is active until you change it through the Project Options dialog. Selecting <UNSPECIFIED> from the Project Options dialog will remove the current preferred annotation property tagged value.

A comment stereotyped with «Annotation» to provide a correct meaning of an item.

The following diagram is an example of how the Preferred annotation property option works. In the figure, a class, autonomous agent, is plotted on the diagram along with five annotations.

A class with annotations in the diagram pane.

The first Containment tree example shows you how they are structured before you select a preferred annotation property from the Project Options dialog. Notice that the Documentation pane shows no annotation when the class is clicked. Using the instructions above, we select the definition as the preferred annotation property for the «Annotation» with the (annotationProperty = definition).

Annotations in the Containment tree before the Preferred annotation property is selected.

The second Containment tree example shows how the annotation ownership changed after you selected definition as the preferred annotation property. If you open the Specification dialog of the «Annotation» with the (annotationProperty = definition), you will see that the new owner is autonomous agent (previously, it was the package Agents’). The Documentation pane will also show the annotation if you click the class autonomous agent.

The annotation appears in the Documentation pane after the preferred annotation property is selected.

Related page