SAP Fiori App Development Guidelines (CAP & Standalone Projects)

General Guidelines (Applicable to CAP and Standalone Fiori Projects)

1. Always ask the user whether they want to create a Fiori app for CAP (Cloud Application Programming) or a standalone Fiori project connected to an external OData service before proceeding with implementation, unless the technology stack is explicitly specified in the user's request.
2. Use the Fiori MCP tools to create the Fiori UI using SAP Fiori Elements.
3. After the Fiori MCP Server tools execute successfully, inform the user of completion. Do not verify or double-check - treat successful tool execution as confirmation.
4. The data model should be suitable for SAP Fiori elements: at minimum one entity type that serves as the main entity for the application. Navigation properties to related entities are optional but enable richer UI patterns.
5. Each property of an entity must have a proper datatype.
6. Before modifying the code directly - first check whether Fiori MCP server provides a suitable function or tool, or if a specialized skill exists (e.g.sap-fiori-analytical-chart).

Available Application Templates (Both CAP and Standalone Projects)

The Fiori MCP can create the following application templates for both CAP and standalone project backends:

1. FE_LROP - List Report Object Page (most common, OData V2/V4)
2. FE_ALP - Analytical List Page (OData V2/V4)
3. FE_OVP - Overview Page (OData V2/V4)
4. FE_WORKLIST - Worklist (OData V2/V4)
5. FE_FEOP - Form Entry Object Page (OData V4 only)
6. FE_FPM - Flexible Programming Model / Custom Page (OData V4 only)
7. FF_SIMPLE - Basic SAPUI5 Freestyle template (can work without a data source)

Available Page Types

The Fiori MCP can add the following page types to existing applications:

1. ListReport - Table view with filtering and search
2. ObjectPage - Detail page for viewing/editing records
3. CustomPage - Fully custom page with your own views

Application Structure

• When asked to create a SAP Fiori elements app, check whether the user input can be interpreted as an application organized into one or more pages containing table data or forms.
• Applications typically start with a List Report page showing data in a table, but other templates are available (see above).
• Details of a specific table row are shown in an Object Page based on the base entity.
• An Object Page can contain sections based on navigation properties (both to-one (0..1) and to-many associations) of its entity type.
• Details of a table section row (for to-many associations) can be shown in another Object Page based on the association's target entity.

Application Preview Guidelines

• Use the most specific script for the app in package.json.
• For CAP: Use watch scripts (e.g., npm run watch-manage-travel)
• For standalone Fiori projects: Use npm start (live backend) or npm run start-mock (mock data)

CAP-Specific Guidelines

1. The fiori app must be created in the app folder under the CAP application root folder created before with cds init operation. This root folder is always a subfolder directly under working directory.
2. When creating UI applications following a CAP application summary, make sure to use UI application names as described in the project structure of the summary, unless user explicitly requested otherwise.
3. On any follow-up request to change or modify the UI of the full stack CAP application, always try first to make the change in the fiori app unless really required in service.
4. Provide primary keys of type UUID for all entities.
5. When creating sample data in CSV files, all primary keys and foreign keys MUST be in UUID format (e.g., 550e8400-e29b-41d4-a716-446655440001).

Standalone Fiori Project Guidelines

1. For standalone Fiori projects based on external services, the application is created at the root level by Fiori MCP tools.
2. Destination or SAP System Name: If the user doesn't provide a destination name or SAP system name, use the Fiori MCP Server to retrieve and present available destinations/systems for user selection.
3. Fetching OData Service Metadata (for initial app creation only): Refer to the tools instructions for downloading OData service metadata. If Service Center MCP is available use that, otherwise use the Fiori MCP Server to download the metadata file. To refresh metadata in an already-created app, see point 8 below.
4. Annotations should primarily be maintained in the backend service, and only app-specific UI customizations or overrides should be placed in local (frontend) annotations.
5. Use frontend annotations only for app-specific UI tweaks (e.g., /webapp/annotations/annotation.xml) referenced in manifest.json with matching uri and localUri values:

   "annotation": {
     "type": "ODataAnnotation",
     "uri": "annotations/annotation.xml",
     "settings": {
       "localUri": "annotations/annotation.xml"
     }
   }
   

6. Standalone Fiori projects connect to remote OData V2 or V4 services (defined in manifest.json dataSources).
7. OData Service Metadata is Read-Only: The service metadata file (/webapp/localService/mainService/metadata.xml) referenced in manifest.json must not be edited locally. Any changes to entity definitions, properties, or service structure must be made at the backend source:

   "dataSources": {
     "mainService": {
       "uri": "/path/to/odata/service/",
       "type": "OData",
       "settings": {
         "annotations": ["annotation"],
         "localUri": "localService/mainService/metadata.xml",
         "odataVersion": "4.0"
       }
     }
   }
   

8. Updating Service Metadata: To refresh the local metadata.xml from the live backend for an existing Fiori app, do not use download_odata_service_metadata (that tool is for initial metadata download during app or page creation, not for refreshing metadata already present in the project). Instead, invoke the sap-fiori-create-cli skill's update service-metadata section.