SAP Fiori Tools - Service Modeler

Description

The SAP Fiori Tools - Service Modeler is a tool that provides visualization of OData service including its backend and local annotations. The Service Modeler helps you easily find entities or projection and their associated annotations.

Features

• Visualization of OData service based on the local EDMX .xml and CAP CDS file within the project.
• View and manage annotations associated with the entities and properties of a service.
• Manage services required for Fiori Elements and Fiori FreeStyle applications, for example adding new services to a project or syncing services that already exist to ensure they are up to date.
• Manage local annotation files associated to the different services of a Fiori Element project. Users can create local annotation files and set the hierarchy for local annotation for a service.

Usage

How to launch Service Modeler

• Use Command Palette -> CMD/CTRL + Shift + P
• Type command -> Fiori: Open Service Modeler or Fiori: Open Service Modeler to the Side

OR

• From the File Explorer in your project, navigate to webapp->localService->metadata.xml
• Right click on the file
• Choose Override Annotations

OR

• Open the metadata.xml file in the text editor
• Click on the Service Modeler icon in the text editor tool bar

How to launch Service Manager

• From the File Explorer in your project, navigate to webapp->manifest.json
• Right click on the file
• Choose Open Service Manager

OR

• Click the 'Service Manager' button from the Service Modeler

How to launch Annotation File Manager

• From the File Explorer in your project, navigate to webapp->manifest.json
• Right click on the file
• Choose Open Annotation File Manager

OR

• Click the 'Annotation Hierarchy' button from the Service Modeler

Using the Service Modeler

• Users can browse and view the OData service in the tree list
• Users can view all the entity types, entities and properties included in the service.
• Users can select an entity and view the properties/annotations of that entity.
• Users can select a property and view the annotations of that property.
• Users can search for entity/property or annotations to filter the displayed data
• Users can filter and only view the metadata targets that have annotations
• Users can override the backend annotations using the Service Modeler.
• Users can navigate to manage the Services and local Annotation files from the Service Modeler
• If the Application Modeler or Annotation Modeler extensions are also installed the user can navigate to these tools from the Service Modeler

Pre Requisites for using this extension

The generated application requires the following software to be installed

• NodeJS Version 18.14.2 or higher

Support

Join the SAP Fiori Tools Community. Ask Questions, Read the Latest Blogs, Explore Content. Please assign tag: SAP Fiori tools

To log an issue with SAP Fiori Tools, please see Contact SAP Support.

Documentation

• Visit SAP Help Portal for SAP Fiori Tools documentation.

License