Skip to content

Latest commit

 

History

History
80 lines (38 loc) · 4.4 KB

visualizing-annotations-with-service-modeler-58784b5.md

File metadata and controls

80 lines (38 loc) · 4.4 KB

Visualizing Annotations with Service Modeler

You can view back-end annotations in the SAP Fiori tools - Service Modeler, and maintain them with XML Code Editor.

Only OData service and CAP service annotations are supported. Annotations are associated with entity types, entities, and properties and are identified by the (Annotations) icon for the entity or properties in the tree list.

You can view the annotations associated with an entity type, entity, or properties displayed in the SAP Fiori tools - Service Modeler Annotation panel.

For OData service, the Annotation panel displays the annotations associated with the target entity in both the back end and local annotations files. The annotation terms defined in the local annotation file win over the same annotation with the same qualifier and applied to the same target in the back-end sources. Back-end annotations can’t be edited via the SAP Fiori tools - Service Modeler tool but back-end annotations can be overridden in the local annotation file and edited manually via a text editor or using the XML Code Editor. The local annotations file is located at /webapp/annotations/<filename>.xml, for more information about how to work with local annotations, see XML Code Editor.

Launching Service Modeler for Annotations

Service Modeler can be launched in several ways.

Using Command Palette

  • Open Command Palette
  • Start typing Service Modeler
  • Select SAP Fiori tools: Service Modeler: Open Service Modeler
  • Select SAP Fiori elements project from your workspace.

Using folder context menu

If you already have an SAP Fiori elements project in your current workspace, you can right-click any folder within your project and Override Annotations.

From the Text Editor

If your metadata.xml file is open in the text editor, click the (Annotations) icon.

Using Service Modeler for Annotations

To view annotations associated with an entity type, do the following:

  1. In the tree list, select the target entity type or the property by expanding the entity type. This will highlight the annotations in the annotation panel.
  2. Click the (Show in Source) icon beside the annotation. The source file is opened to the side with the annotation highlighted.

Searching for Annotations

Enter the search criteria in the search input box in the upper-right corner. The annotations matching the search criteria are listed in the annotation panel. The entity and properties to which the resulted annotations are associated are also filtered in the tree list.

Editing Annotations

You cannot edit back-end annotations with the SAP Fiori tools - Service Modeler. However, you can edit local annotations by navigating to XML annotation language server with the Service Modeler.

  1. Select the target entity set in the tree list, this will highlight the annotations in the side panel.

  2. Click the (Show in Source) icon opposite the selected local annotation in the service local annotation file.

  3. Edit the local annotation manually in the XML Code Editor and save the local annotation file.

Deleting Annotations

  1. Select the target entity type or property with annotations.
  2. In the annotation panel, click the 🗑️ (Delete) icon opposite to the selected local annotation in the service local annotation file.