Fiori annotations

Describing a service so a Fiori client can render it without hand-written UI code — titles, value helps, hierarchies and visibility expressed as model annotations rather than screen logic.

Overview

SAP SHIPS

The compiler translates annotations from the OASIS and SAP OData vocabularies, @UI and @Common among them, into the EDMX a Fiori elements client reads, with names and positions exactly as the vocabularies specify them, so every term in those vocabularies is available without a mapping written per term. CDS shortcuts sit on top: @title and @description map to @Common.Label and @Core.Description, @cds.odata.valuelist gives every managed association that targets the annotated entity a value list and is already set on the reuse types of @sap/cds/common, and @hierarchy expands to the annotate and extend statements a tree view would otherwise need by hand. A vocabulary SAP does not ship enters the translation through the cds.cdsc.odataVocabularies configuration, which names its alias, namespace and URI. During development the Fiori preview link on the index page serves a list page from the annotations before any app exists.

Not covered: It stops at translating what the model states. Labels, read-only and mandatory fields, value lists on managed associations and recursive hierarchies have a CDS shortcut; every other term, UI.LineItem and UI.SelectionFields among them, is written out in the vocabulary's own structure. A field that is not a managed association gets no value list from the shortcut. A tree view still needs the hierarchy qualifier and the TreeTable setting in the UI5 app's manifest.json, which is the app's file rather than the model's. Hiding a control by role takes a singleton and an on handler of the developer's own. For a vocabulary outside the standard set the compiler has no access to the vocabulary's content, so the values are translated generically and nothing checks that a term is applied where it belongs. The preview is disabled in production.

SourceServing SAP Fiori UIschecked
THE COMMUNITY ADDS

Three cds-plugins write Fiori vocabulary terms a model would otherwise carry by hand. @mpah/enum-value-help covers the case the value-list shortcut leaves alone, a field typed by a CDS enum, by adding @Common.ValueList against a generated view of the enum's own values. cap-js-geoloc-plugin generates the actions, and under autoCalculate the side effects, that its own address and route annotations imply. urp-vocab publishes a vocabulary of its author's own rather than SAP's, so what reads it has to be a matching renderer.

Artifacts1

1 of 1 artifacts
ArtifactSignals
Packages1
@sap-ux/odata-vocabulariesOASIS and SAP OData vocabularies with a VocabularyService
Signals
none

Content44

Group by44 of 44 pieces
Piece, what it offers
A Guide to CDS Metadata Extensions, Fiori App Generation and SAP UI5 Controller Extensions
SAP Community, ankitapaul229, Blog
Reading Between the Lines: Under-Documented Fiori Elements Capabilities in SAPUI5 1.149
SAP Community, Sören Leibach, Blog
Dynamic Criticality in SAP CAP Using Fiori Elements and Node.js
SAP Community, Pranesh_SD, BlogThe reasoningA recipe
Show 41 more
Deep Insert in SAP CAPM Using Composition and Fiori Elements
SAP Community, Talari Hari Kumar, BlogThe reasoningA recipeRunnable code
From SEGW and Legacy UI5 to RAP with ARC-1
blog.zeis.de — Marian Zeis, Marian Zeis, part 7 of 10, BlogRunnable codeThe reasoning
New majors
XML Annotations: The Essentials Before Adapting Documentation Samples to Your Project
SAP Community, MioYasutake, BlogThe reasoningRunnable code
Building an Enterprise Application Using Fiori Elements and CAP - Part 1
SAP Community, Farooq, part 1 of 3, BlogThe reasoning
Building an Enterprise Application Using Fiori Elements and CAP – Part 2
SAP Community, Farooq, part 2 of 3, BlogThe reasoning
Building an Enterprise Application Using Fiori Elements and CAP – Part 3
SAP Community, Farooq, part 3 of 3, BlogThe reasoningRunnable code
Core changed
Adaptation Project: SAP標準Fioriアプリのフィルタ項目を必須入力へするための方法
SAP Community, hironobu_nakayama, Blog
SAP BTP Developer's Guide: Extending Fiori Elements with the Flexible Programming Model
SAP Community, Navin Krishnan, BlogThe reasoning
How to Control the Visibility of CRUD and Custom Actions in Fiori Elements Based on Authorization
SAP Community, Mio Yasutake, BlogThe reasoningRunnable code
Visualizing Your SAP Bill of Materials Using CAP, Fiori elements, and the UI5 Network Graph
SAP Community, Marian Zeis, BlogThe reasoningRunnable code
Core changed
Simple Table Maintenance in SAP Fiori Using UI5 Smart Controls
SAP Community, Marian Zeis, BlogThe reasoningRunnable code
Use SAP CAP SAPUI5 Smart Filter to Show Value Help that are not Associated Entitites
SAP Community, JhoelAnthonyRamosRomeroPE, Blog
Calling bound / unbound CAP actions from Fiori elements application.
SAP Community, vidhyasagarmule, BlogThe reasoning
Fiori Elements のList Reportアプリにカスタムアクションボタンを追加し、カスタムコントローラーを用いてアイコン化する
SAP Community, takayuki_tanaka, BlogA recipe
Extend Upload Set with Table to Fiori Elements and utilize Object Store
SAP Community, Kazuhiko Takata, BlogThe reasoningRunnable code
Core changed
CAP with Fiori Elements: Actions on List Report / Object Page using Annotations - Part1
SAP Community, Ajit_K_Panda, part 1 of 2, BlogThe reasoningA recipeRunnable code
Core changed
CAP with Fiori Elements: Actions on List Report / Object Page using Annotations – Part2
SAP Community, Ajit_K_Panda, part 2 of 2, BlogThe reasoningRunnable code
Core changed
CAP with Fiori Elements: Configure Multiple Views on List Report Tables
SAP Community, Ajit_K_Panda, BlogThe reasoningRunnable code
Core changed
CAP - Dynamically hide UI facets in Fiori Elements
SAP Community, AjayRathore, BlogA recipe
Core changed
Create Fiori List Report with object page using CAPM(node.js) Service
SAP Community, Md_sanaullah, BlogThe reasoning
Developing SAP Fiori Element application by using SAP Cloud Application Programming Model
SAP Community, shobhit, BlogThe reasoningA recipeRunnable code
Core changed
CAP with Fiori Elements: Side Effects, Custom Actions, Dynamic Expressions
SAP Community, Ajit_K_Panda, BlogThe reasoningRunnable code
Core changed
How to ensure that users can efficiently enter data in SAP Fiori elements applications
SAP Community, Marius Freitag, BlogThe reasoningRunnable code
Display of hierarchical data in SAP Fiori elements using SAP Cloud Application Programming Model
SAP Community, OliverKlemenz, BlogThe reasoningRunnable code
1 stale part
Case-insensitive filters in Fiori Elements (List report + CAP)
SAP Community, Kishannaicker, Blog
Extend SAP SuccessFactors on SAP BTP with CAP - Develop the SAP Fiori Elements Application
SAP Community, ale_biagi, BlogThe reasoning
Build and deploy a CAP Project Node.js API with a SAP Fiori Elements UI and a managed approuter configuration
SAP Community, jlong, BlogThe reasoningA recipeRunnable code
Core changed
The SAP Fiori elements feature showcase with CAP CDS annotations
SAP Community, stefaniehager, BlogThe reasoning
Build SAP Overview Page using SAP HANA Cloud & SAP CAP service annotations in Visual Studio Code
SAP Community, Sai_Nithesh_G, BlogThe reasoningA recipeRunnable code
Core changed
SAP CAP Remote Services & SAP Fiori Elements
SAP Community, Former Member, BlogThe reasoningA recipeRunnable code
Core changed
From R/3 ABAP to CAP/Fiori Elements on SAP BTP- Deployment
SAP Community, former_member231477, BlogRunnable code
Core changed
From R/3 ABAP to CAP/Fiori Elements on SAP Cloud
SAP Community, former_member231477, BlogThe reasoningRunnable code
Core changed
Discovering SAP Fiori Elements Analytical functions by implementing SAP Support Message Reporting
SAP Community, Gregor Wolf, BlogThe reasoningRunnable code
Create an SAP Fiori Elements UI for CAP Node.js applications in SAP Business Application Studio
SAP Community, liat_b, BlogThe reasoning
Part 2: How to build an extension application for SAP S/4HANA Cloud using CAP, SAP Cloud SDK and SAP Fiori elements
SAP Community, former_member748, part 2 of 2, BlogThe reasoningA recipeRunnable code
Core changed
Part 1: How to build an extension application for SAP S/4HANA Cloud using CAP, SAP Cloud SDK and SAP Fiori elements
SAP Community, former_member748, part 1 of 2, BlogThe reasoningA recipeRunnable code
Core changed
Random collection of useful code fragments for CAP Fiori Elements and SAPUI5
SAP Community, leoirudayam, BlogThe reasoningRunnable code
Core changed
SAP Fiori Elements using CAP Model - Introduction
SAP Community, jhodel18, BlogThe reasoning
Developing a Fiori elements app with CAP and Fiori Tools
SAP Community, MioYasutake, BlogThe reasoningA recipeRunnable code
Core changed
Developing Fiori Element Application (List Report and Object Page) consuming the OData service created using SAP Cloud Application Programming model
SAP Community, former_member187069, BlogThe reasoningA recipe
Core changed
Develop a Full-Stack CAP Application Following SAP BTP Developer's Guide
SAP Developer Center, SAP, WorkshopThe reasoningA recipe

Seen working6

ArtifactSignals
Samples6
cap-materialbom-graphCAP sample drawing a material BOM as a UI5 network graph
No license
fiori-table-maintenanceCAP and UI5 app for in-place table maintenance with SmartTable
No license
SAP-samples/teched2022-DT181TechEd 2022 workshop mixing SAPUI5 with Fiori elements building blocks
none
ui5-call-actionUI5 apps calling CAP OData actions and functions from custom code
No license
ui5con-2026-fiori-building-blocksSession building a travel dashboard with Fiori elements and SAPUI5
none
wdf2025-fiori-innov-day-building-blocksFiori Innovation Day session building a travel dashboard
none

Details

Coverage
statecore and community, UI5
assessed
relationshipunassessed
also inCAP, ABAP
For your agent
Ref
capability:fiori-annotations
JSON
/capabilities/fiori-annotations.json
MCP
Connecting an agent