Show TOC

Annotation EditorLocate this document in the navigation structure

You can make user-specific changes to a data model by adding annotations. You add and edit annotations for User Centric (UC) data models and its entities using the Annotation Editor.


You cannot, however, annotate Public Solution (PS) data models. If you want to add annotations to models of type PS, you must first create a UC data model derived from the PS data model, which you can then annotate. For more information, see Deriving a Data Model from an Existing Data Model.

After you have browsed to the data model you want to annotate, expand the tree view in the left-hand area of the screen and select the element you want to annotate. The Annotation Editor is displayed on a separate tab in the right-hand screen area:

The Annotation Editor has a tree layout and you can expand and collapse its elements. The editor includes the following buttons Find, Print view, and Change layout.

The Description column shows a short description for each annotation element; an i (information) enables you to access further Help documentation for the element you are annotating (data object, property, relation, operation).

The Value column displays values that you enter (and any existing values).

To switch to edit mode and make the changes you require, press the Display<->Change button (the pen icon) at the top left of the screen. Some fields remain read-only.

Select the appropriate checkboxes in the Include Annotation column or double-click an element so that its annotation field displays at the bottom of the screen. You can enter or change a value, or select a new value from a dropdown menu:

Adding Annotation

If a dropdown menu exists, it contains values (for example, true and false) you can select, but if no dropdown menu is available, you can enter free text in the field. The maximum length for an annotation value is 255 characters and the structure of the annotation is also subject to validation.

When you select the Include Annotation checkbox for an element, its parent folder is also automatically included (folder checkbox is selected). If mandatory elements exist, the checkboxes are selected as default and you cannot deselect them.

To delete an element's annotation, deselect its checkbox in the Include Annotation column. When you deselect a folder, this deletes all annotations for this folder's elements (all checkboxes within the folder are deselected).

To display different fields in the Annotation Editor, select a different element from the model in the tree view (data object, property, relation, operation).

After adding, modifying, or deleting values, save your changes in the data model.