SAP-samples / abap-platform-fiori-feature-showcase

Feature showcase that demonstrates and documents how to implement annotation-driven SAP Fiori Elements UI features for oData V4, using the ABAP RESTful Application Programming Model (RAP).
Apache License 2.0
169 stars 37 forks source link
abap abap-environment abap-restful fiori-elements open-source rap sample sample-code sap-cloud-platform

REUSE status

SAP Fiori Element Feature Showcase App for the ABAP RESTful Application Programming Model

App List Report App Object Page

The focus of this project is to demonstrate the features of annotation-driven SAP Fiori Elements for oData V4, using the ABAP RESTful Application Programming Model (RAP). The oData V4 app has been developed to be transactional- and draft- enabled.

To run the feature showcase app, pull the source code from GitHub into your system (see instructions below for different system types), locate the Service Binding and publish it locally. You can start the app preview by selecting the Root node. You can also run it by building your own Fiori app using the SAP Business Application Studio and connecting to the backend via the service binding.

[!TIP]
A corresponding app built using CAP can be found at https://github.com/SAP-samples/fiori-elements-feature-showcase.

[!IMPORTANT]
A number of issues have been identified and documented in the Wiki Identified Constraints.



:wrench: How To... Build

For ABAP Platform Cloud

Choose this if you are working on SAP BTP or SAP S/4HANA Cloud, public edition.

To import the feature showcase app into your ABAP Environment, follow the steps in the README file of the branch ABAP-platform-cloud and download the sources from this branch.

For ABAP Platform

Choose this if you are working on SAP S/4HANA, on-premise edition or SAP S/4HANA Cloud, private edition.

To import the feature showcase app into your ABAP system, follow the steps in the relevant README file and download the sources from the branch corresponding to your backend version:

SAP BTP ABAP Environment Trial

If you don’t have a system available, you could also try it out in the SAP BTP ABAP Environment Trial systems. Check out this tutorial on how to get a trial user.


:book: How To... Use the Guide

The Updated Guide is divided into 6 sections. You can peruse it on your own without refering to the app, based on what you want to implement.

Documentation Description
General Features Describes the features that are generally used throughout, be it in the List Report or Object Page
List Report - Header Describes the features that are for the header area of the List Report
List Report - Content Describes the features that are for the content area of the List Report
Object Page - General Describes the features that are generally used for Object Page
Object Page - Header Describes the features that are for the header area of the Object Page
Object Page - Content Describes the features that are for the content area of the Object Page

For searching via the search term from the App, there are 2 ways:

If you have a user in GitHub

...when you see a feature that you would like to implement, copy or take note of the search term (e.g., #SearchTermExample) and perform a search in the Repository. Clicking on a result brings you to the markdown code of the respective Guide, so just click on the Preview and search for the term again.

How to search

If you don't have a user in GitHub

...you can still use the old way and search in the Wiki instead.

How to search

From the Guide, you will get

Alternatively, you can search for an annotation in the Guide/Wiki, get the search term, and use it to locate the UI feature in the app. If the annotation cannot be found, it could simply mean that it is not showcased in the current release.


:telephone_receiver: How To... Obtain Support

This project is provided "as-is": there is no guarantee that raised issues will be answered or addressed in future releases. However we do welcome your comments or reports, so please use the Issues feature to report them.


:memo: License

Copyright (c) 2022 - 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the SAP Sample Code License except as noted otherwise in the LICENSE file.