SAP Fiori Elements : CDS And Overview Page-Part 2
In this blog, we would be developing an Overview page with 1 Analytical card with navigation to Multidimensional query. I have tried to keep this blog very detailed . My motivation to write this another blog is to give an idea on understanding the architectural relations between S/4 Hana Embedded analytics (SAP Fiori Elements + OData + Core Data Services ) .
Please follow and re-read all the steps carefully.
- Please read SAP Fiori Elements : CDS And Overview Page-Part 1(SAP Fiori Elements and CDS View-Part 1) before this.
- Cloud connector and Destination should be properly configured.
- Access to Business Application Studio.
- Either you can go to SAP Business application studio from service marketplace in SAP BTP or you can directly connect with SAP Basis team to get the link for SAP BAS.Note : SAP BAS is a licensed product and each license is deployed by the either Client or the relevant organization. Hence , to get a clear understanding if you have the license , you will have to take help from SAP Basis or the relevant Account Manager (refer to KBA 3197520 – Questions Regarding Licensing and Sales of SAP Business Application Studio – SAP for Me)
- Access to TCodes such as ui2/flpd_cust (fiori launchpad designer) , ui2/iwfnd/maint_service(activation of OData services) , SE80 (ABAP Repository browser) , /ui2/semobj (Creation or display of semantic objects) and /ui2/flp (fiori launchpad).
- Basic knowledge in SAP Fiori.
- Should be able to create a Catalog , Tile and configure target mapping.
Introduction about the Blog:
- We will be developing an Overview Page using a front end tool Business Application Studio using open guided development . This feature of Open Guided development in Business applicaiton studio minizes the need to write the code manually and reduces effort and time.
- Type of Card and chart used in this blog – Analytical Card (Column chart)
- Navigation from Overview Page to Multidimensional query( Query browser/WebDynpro).
Please follow the below steps for the development of an analytical card in Overview page
- Cloud connector should be connected .
Hence, go to SAP BTP -> Connectivity-> Cloud connector -> Check the Cloud Connector connection :
- Destinations in SAP BTP should be configured properly(take help from SAP BASIS team) before starting the development in Business app studio.Click on the below icon to check if the connection is successful.
- Once the Cloud connector and destinations are configured properly , you can start developing applications in Business application studio and can deploy the applications to the development server via BAS.
- In SAP BTP, go to service marketplace and search for Business application studio:
- Open Business application studio and click on ‘Create Dev Space
- Provide custom dev space name and check relevant ‘SAP Extensions’ and click on ‘Create Dev Space’.
Note: Dev Space will be present only locally . This is just like a local repository which will contain all your SAP Fiori projects in Business application studio.Now, inside the Dev space, click on ‘Start from template’ in the home screen or you can go to File->New Project from template :
- Click on ‘Sap Fiori Application’.
- Click on Overview Page
- Dropdown to ‘Data Source and service selection’ and click on ‘Connect to a system’ :
- Select the destination which has been configured in SAP BTP (refer to step 3) and click on Next .
- Select the OData Service which was activated in the last blog (ZOVP_DEMO3_CDS) (Link – > OVP – Part 1 ) :
- Select the filter entity (Filter Entity:FILTER Entity Type contains all the attributes of the service.These attribute properties will be a part of Global Filters).
Note : Check Entity Type and entity set in the metadata of the service (covered in the last blog in detail. )
- Provide the Module (BAS Project) name (zovp_demo3), application title name, application namespace(same as module name for ex) , Description, path(BAS folder path for the project to be saved) , SAP UI5 Version(depending on the SAP Fiori version) and click on Next. select ‘Add deployment configuration’ ( For adding the Transport details ) and ‘Add FLP Configuration’ ( For adding semantic object and action -> for navigation purpose):
- In ‘Add deployment configuration’ , provide Target as ‘ABAP’ as the application has to be deployed as BSP application in SE80 repository,
Destination : chose correct destination configured in SAP BTP
SAPUI5 ABAP Respositry : Provide any custom name of the app .
Deployment description : Description of the application
Package: Package name
Transport Request : Provide a workbench transport request.
- Click on Next and in ‘Add FLP configuration‘ , provide a semantic object and action (unique action name) .
Create a custom semantic object->Zfiori_objlist in /ui2/semobj TCode in SAP GUI.
ACTION can be custom/standard name given by a developer based on the requirement to distinguish different multidimensional queries at the time of navigation from Analytical card to Query browser ).Now, click on Finish.
- Project(zovp_demo3) is created.Once the project is created , BAS automatically generates folders and files which is a very big advantage of using Open guided development. In case of SAP Fiori Elements , best way to proceed to develop different floorplans is using Open guided development . Also, in case of developing a custom UI5 application from scratch (UI5 freestyle), it is advisable to proceed accordingly by creating views, controllers etc .Below is the usage of each file and folder created under the project zovp_demo3:WEBAPP : Contains files such as annotation.xml, i18n ,VAN.xml, manifest.json etc.
ANNOTATION.XML : Used to mention annotations and attributes related to chart(@UI.Chart), navigation (UI.Identification) , UI.PresentationVariant(Configure how data is displayed ), UI.DataPoint etc. Details related to each annotation and it’s usage are mentioned in the below steps while we will be proceeding with open guided development.
i18N : Used to maintain texts globally in different languages such as EN, ES, FR etc.
LocalService-> *VAN.XML : Used to maintain selection screen fields , parameters etc.
Manifest.json : It is the main and important file which contains Data sources, Models , Folder paths linked to annotations file,VAN file,i18n , card related settings etc.
Package.json : Your package.json contains all the important info about your project. It includes the project’s name and description, as well as other useful stuff like the package’s version number and any dependencies the app needs. Also , to prevent different environments from having different installed dependencies and to get the same results across all environments , package.json is used. (Dependencies can be generated when a Fiori application already exists as a BSP application and needs some enhancement. If you want to generate dependecies , you can refer to my 3rd blog of the series which contains the information on how to generate dependencies ) .Now, Right click and select ‘Open Guided Development’ to create a card:
- Click on ‘Add an analytical card to an overview page’:
- Below is the detail description of the analytical card guide in BAS:
- Step 1(Mandatory) :
UI.Chart Annotaion – Used for all configurations related to the chart
(Chart Type, X-axis : Dimensions, Y-Axis : Measures/KeyFigures ).Here , Entity Type to be mentioned same as mentioned in Step 12.
Chart Qualifier : Specify any custom qualifier(zchart_quali) which will contain all the attributes such as Chart title, Chart Description, Dimension property, Measure property and Chart Type.
Provide the relevant details as below and click on Insert Snippet which will add the code automatically in annotations.xml file.
You can check the inserted code by opening annotations.xml file parallely .Now, Click Next :
- Step 2(Optional) :
UI.PresentationVariant – PresentationVariant can contain configuration of how the data is displayed . For example, Sort order(usually needed when using X axis as a time based dimension such as Year, Year Period etc) , max number of rows etc.
Configure this step, if needed as per the requirement or else , click Next .
- Step 3(Optional):
UI.DataPoint : A data point is a single item of information. It is usually a numerical representation, but may also be a textual representation. Know more about Datapoints-> Data Points .If required, configure this setting or else click on Next.
UI.Identification: This is basically used for Intent Based Navigation which means that this annotation/functionality is used for navigating to any URL( for eg : Navitation to SAP Analytics Cloud dashboard, or a desginated URL) and navigation to a multidimensional queries/Webdynpro apps which is configured via Fiori Launchpad designer through custom semantic objects and actions.
Note : In our demo , we are developing 1 Overview page with 1 analytical card containing a column chart. Once an end user clicks on a key figure/measure value configured for dimensions(X-axis) in the chart , it would navigate to query browser(detailed output) in another screen.
Provide Entity type and a custom qualifier(for eg : zident_qualifier).
Now, we will provide a created semantic object(Zfiori_objlist) and standard/custom action(standard action->display) (refer step 15) which would be configured later in SAP Fiori Launchpad Designer .
Click on Insert Snippet and Next.
Enter the Unique custom Card ID(Card ID name present in manifest.json file) .
Enter the Entity Set name :
Dropdown to Chart annotation path and enter the qualifier name(zchart_quali) entered in step:
Dropdown to Identification qualifier and enter the qualifier name entered in step 4(zident_qualifier) . Insert Snippet and click on exist guide:
globalFilterModel : Represent the main global filter. The metadata (dimensions) will be present inside mainModel.
globalFilterEntityType : This is the entity type(refer step 13)
considerAnalyticalParameters: If parameters are present in the analytical report, then select True or else, False.
cards: This section comprises of the number of cards and it’s related settings to be present in an OVP.
ZCard_123: 1st analytical card name.
enititySet: This is the entity set(refer step 13)
chartAnnotationPath : This is UI.Chart annotation which we have configured above in Point 20 (step 1) ( format -> com.sap.*#CustomQualifierName)
identificationAnnotationPath: This is UI.Identificaiton annotation which we have configured above in Point 23 (step 4) ( format -> com.sap.*#CustomQualifierName)
- Now, right click on the project name (zovp_demo3) and select ‘Open Service Manager’ to view the OData service being used in the project.
- Preview the application:
Right click on the project and click on ‘Preview Applicaiton’:
Now click on Start fiori run(This will hit YAML files present in the project) :
And, below is your First Overview Page application with 1 analytcal card :).
Note: The above created Overview page and analytical card exists only in Buisiness application studio tool as of now. Now , in order to run the application in Fiori launchpad and make it available for end users, we will have to deploy the application first from Buisiness application studio tool to the Fiori development server.
Once you deploy your application in Development server , it is deployed as a BSP applicaiton in ABAP system(refer point 26) and is captured under a workbench transport request which can be transported to Quality(QA) and then to Production servers . This is the main reason why cloud connector and SAP BTP destinations are needed to be configured properly.
- Deployment : ( For detailed information , please refer Deploy a Fiori App using BAS/WebIde ).SAP offers two distinct options for the deployment of SAP Fiori applications: one is to deploy the application to an ABAP system(as a BSP applicaiton in ABAP repository(SE80 Tcode) , such as SAP S/4HANA, and the other is to deploy the app to Cloud Foundry.
Follow the below steps to deploy your app to SAP ABAP system:
Step 1: Right click on the project (zovp_demo3) and click on ‘Open Terminal’ to go to the Terminal section to deploy the application to the development server:
Step 2: Below is the terminal window:
npx fiori add deploy-config:
Press enter and provide the relevant details in the terminal as below and proceed :
Please choose the target : ABAP / Cloud Foundy –> Choose ABAP
Destination -> It will come by default as configured in SAP BTP
SAPUI5 ABAP Repository -> Provide any custom project name to be deployed in SE80 as BSP application.
Deployment Description -> Provide any custom project Description for SE80.
Package -> Provide a package to be used for the Fiori development.
How do you want to enter Transport Request -> Choose from existing / Enter Manually – Choose the relevant option and proceed
Transport Request -> Provide a workbench TR present in Fiori development
Start deployment (Y/n)? -> Click ‘Y’ and proceed for the deployment
Now since the application has been deployed , there should be Fiori Catalog,Business Group,Relevant roles and Fiori Tile to view that application.
So let’s :
Create a Fiori Catalog,
Create a Fiori Tile,
Complete Target Mapping,
Create a Business Group,
Get relevant user roles from security team,
And finally Add the application in the particular businss group in the Fiori launchpad.
Note: If the catalog is not created, create a new catalog as per the requirement.
Refer to the link->SAP Fiori Catalog/Tile/Target Mapping- Link 1 or SAP Fiori Catalog/Tile/Target Mapping- Link 2 for the catalog/tile creation/target mapping.
We have already created a catalog ‘ZDEMO_TEST‘ which will have our new Tile. Hence In the catalog ‘Zdemo_test’, below are the steps to create a new tile for the above overview application.
Click on the ‘+’ button:
Note: Provide the same Semantic object and action as provided while configuring in Business application studio (Point 22).
Click on the ‘Target Mapping’ icon and Click on ‘Create target mapping’.
Semantic Object and Action: Semantic object and action in target mapping is the linking and between tile and target mapping. Provide the same semantic object and action configured in Step 3.
Note: You have to configure target mapping 2 times .
First time,target mapping is used to navigate from Fiori Tile to the Overview Page where semantic object ->ZFiori_objlist, action-> display) ( Refer to point 33 and check the URL )
Title: Provide the same title name as mentioned in step 3.
URL: The URL /sap/bc/ui5_ui5/sap/zovp_demo3 ( ZOVP_DEMO3 is the project name given in Business application studio).
ID: ID is the application namespace present in manifest.json file in BAS.
- Add the tile to the Business group :
Click on ‘Groups’ and go to the created group and click on ‘+’ button:
Click on F4 help :
Give the catalog name (ZDemoCatalog) and select the catalog :
Click on the Tick mark to add the tile to the Business group also.
- After the configuration of Target mapping/Tiles/Catalogs/Groups , get relevant authorizations and roles access of catalog and CDS Views from the security team. Once you have the relevant authorizations , go to Fiori launchpad .
- In the fiori launchpad, go to settings->App Finder ( to add the tile in the relevant catalog ):
- Search for the created catalog which contains the above created tile ‘Overview Page Demo’ and add it to the required group as shown below:
- Tile ‘Overview Page Demo’ is created like below in the Fiori Launchpad. Once we click on the tile, it will navigate to the Overview Page which we have configured.
- In the URL , we will be able to see semantic object ‘ZFiori_objlist’ and action ‘display’ which we have configured in Fiori Launchpad Designer in point 27(Step 5).Note : Below OVP comprises of global filter which has 3 optional fields and 1 mandatory field (Currency) which is displayed here if you add @UI.selectionfiields annotations and @Consumptions.filter annotations in the CDS level.
You can also click on Adapt filters to add more filters to the global filter. We will be exploring more on global filter and multiple cards in the upcoming blogs .
- Again Congratulations 🙂
Your 1st Overview Page is created with a global filter and is present in the Fiori Launchpad. Few questions must be arising in your mind that :
Now, how to navigate from this chart to Multidimensional reports or WebDynpro Applications?
How to navigate to the detailed output once you click on any column of the fiscal year and it should display the overall data for the same year along with each key figures and dimensions in Query browser?To solve the same purpose, SAP has come up with Intent Based Navigation in SAP Fiori , which we willl be setting up in the further steps .
- Go back to the Fiori Launchpad designer(/ui2/flpd_cust) and in the same catalog and tile which we have configured in point 27, click on ‘Create Target mapping’ again for the navigation from the analytical card to a multidimensional report (Query browser) .Note : If you remember , we discussed in point 28( step 5 ), that we have to configure target mapping 2 times . Hence ,this is the 2nd time that we will be configuring the same.
- Provide the below details again:
Semantic Object – Same as provided earlier
Action – Provide any custom action name , as this action will be configured in Business application studio in annotation.xml file as shown below:Application type: SAP Ui5 Fiori app.
URL : This is the standard configuration for a query browser(/sap/bc/ui5_ui5/sap/FIN_DS_ANALYZE ) .
Parameter 1 -> XQUERY : Provide 2CSQLViewName in the default value. (For analytical queries)
Parameter 2 -> XSEMANTIC: Provide * in the default value.
Parameter 3 -> Z**** (<SAP System Alias (to the backend system), e.g. S4FIN) .
annotation.xml file in Business Application Studio:
- Now go to fiori Launchpad(/ui2/flp) ,click on the tile Overview Page Demo, it will navigate to the Overview Page which we have developed :
You will be able to see semanctic object and 1st action configured in taget mapping in FLPD_CUST:
- Now,click on the fiscal year 2022 in the analytical card and it will navigate to the Multidimensional report(query browser):Note : In the below URL, you will be able to see same semantic object(Zfiori_objlist) and 2nd action(zident_ovpdem) configured in taget mapping in FLPD_CUST.Congratulations 🙂 . You have :
- Created a basic Overview page with 1 analytical card in Business application studio.
- Deployed the application to the development server.
- Learned Intent based navigation where you have navigated to Multidimensional query
- To be continued……..Part 3 – Development of Overview page with multiple analytical with navigation to Multidimensional query. (yet to be published)Part 4 – Creation of a Global filter for a SAP Fiori Element ( here an Overview Page) and linking the global filter with multiple cards in Overview page.. (yet to be published)