Tell us what you think

We want to create the best possible experience for our learners. Your feedback helps us to improve the experience for everyone.

Configuring Fact Sheet Apps and SAP Fiori Search

Objectives

After completing this lesson, you will be able to:

Manage Enterprise Search
Configure fact sheet apps

Enterprise Search

SAP Fiori search enables users to search for business objects across the SAP S/4HANA system and to search for apps in the SAP Fiori launchpad. It uses the SAP HANA enterprise search service.

To activate ICF services and to set the SAP HANA connection, run the SAP_ESH_INITIAL_SETUP_WRK_CLIENT task list. In addition, the search connectors for the fact sheet apps can be created.

Note

The manual steps can be performed using transaction ESH_IMG for the setup and ESH_COCKPIT for the search connectors.

Screenshot of the system: Create and Index Search Connectors

If not already performed in the SAP_ESH_INITIAL_SETUP_WRK_CLIENT task list, the SAP_ESH_CREATE_INDEX_SC task list can be used to create the search connectors of multiple apps. The last step is then registering the SAP Gateway services like for transactional apps.

Note

The manual steps can be performed using transaction ESH_COCKPIT.

Create connectors in the Connector Administration Cockpit (transaction ESH_COCKPIT). The connectors required for each object page and the relevant search software components are documented in the implementation documentation for the single object pages.

When you launch transaction ESH_COCKPIT, you may get an error message "Model data is currently being fetched from another client". The root cause is an update of search models, where data is replicated from the SAP reference client 000 to the actual client. In this case, wait some time and start transaction ESH_COCKPIT again. This is described in SAP Note 3278473.

Manage Enterprise Search

Business Example

Fact sheet apps are based on search models. In this exercise, you will launch tools to manage Enterprise Search models.

Note

In this exercise, when an object name or value contains ##, replace ## with the number your trainer assigned to you.

Task 1: Optional: Analyze Logs of Task List SAP_ESH_INITIAL_SETUP_WRK_CLIENT

Steps

In your SAP S/4HANA system, retrieve the logs of the SAP_ESH_INITIAL_SETUP_WRK_CLIENT task list (transaction STC02).
1. Log on to your SAP system using the train-## user.
2. Enter transaction STC02.
3. In the Task List field, select SAP_ESH_INITIAL_SETUP_WRK_CLIENT.
4. Remove your user from the Created By field.
5. Choose Start Search (F8).
6. Select the task list run by double-clicking on it.
7. Choose Display Logs to access the log of that task list run.

Result

Task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT was executed successfully.

Task 2: Launch the Search Connector Administration Cockpit

Steps

In your SAP S/4HANA system, launch the Connector Administration Cockpit, using transaction ESH_COCKPIT.
1. Log on to your SAP system using the train-## user.
2. Enter transaction ESH_COCKPIT.
  Note
  The first call may take some time.
3. Wait until the Web Dynpro ABAP application ESH_ADMIN_UI_COMPONENT (ICF service /sap/bc/webdynpro/sap/esh_admin_ui_component) has been started.
  Note
  In case of a "Model data is currently being fetched from another client" message, wait a moment and enter transaction ESH_COCKPIT again (see SAP Note 3278473).
4. Within the Web Dynpro ABAP application, examine a search object connector, for example, Bank.

Result

You can launch the Connector Administration Cockpit to manage search connectors.

CDS-Based Enterprise Search Connectors

Enterprise Search allows you to search all structured data in an application in a unified way. The key user can select a search model and view the search results in a simple and formatted way.

ABAP Core Data Services (CDS) Views are the basis for all object pages in SAP S/4HANA. ABAP CDS Views utilize the search capabilities of the SAP HANA database by integrating with the SAP HANA enterprise search. That results in generated so-called CDS-based enterprise search (ES) connectors. Like the search connectors based on search models, they can be managed in the connector administration cockpit.

Since SAP S/4HANA 1809, additional SAP Fiori apps are available for managing CDS-based ES-connectors:

Analyze Query Log [F2571]: Evaluate log data containing user activities collected during searches, graphically in bar charts, or in tables.
Define Search Behavior (Synonyms) [F2700]: Display search configurations of business objects, create synonym and stop-word lists and display where-used lists for configuration settings.
Fine-Tune (Search) Ranking [F2777]: Create and edit ranking factors and boosts, and test their effects immediately in a simulation.
Manage Searchable Business Objects (Display Enterprise Search Models) [F3036]: View technical details of search connectors, their status (Active or Inactive), and activation logs.

Figure shows screenshot with labels illustrating the Manage (CDS-Based) Search Models app

The Manage Search Models app enables a unified search of all structured data of a search model. Using this app, you can view the technical details of all the available CDS-based search models, regardless of their status (Active or Inactive), and the descriptions of the search models with the application area in table format. You can navigate to each search model and view the artifacts, such as the underlying CDS views on which the search model is built, fields, ranking, the relationship between the views, technical details of the search model, and a preview of the search results.

The search on the shell bar in the shell header displays a list of search connectors. When you select a search connector, you can view the search data results, filters, and navigation details, if these have been defined. The structure of the result data, such as fields, the position, and the format is defined in the search connector.

Figure shows a screenshot of the Setup the Adaptation Transport Organizer (ATO) for Key User Tools screen in the system

Some SAP Fiori apps require the Adaptation Transport Organizer (ATO) to be set up before these apps can be used as desired. For more information about what apps require the setup of the ATO, please refer to the implementation information of the individual apps. For more details on the ATO, please refer to SAP Note 2283716.

One of the apps which require a configured ATO is the Manage Search Models app.

(Optional) Manage CDS-Based Enterprise Search Connectors

Business Example

Fact sheet apps are based on search models. In this exercise, you will launch tools to manage CDS-based search models.

Note

In this exercise, when an object name or value contains ##, replace ## with the number your trainer assigned to you.

Task 1: Enable the Manage Search Models App

Steps

In the SAP Fiori apps reference library, open the configuration details for the Manage Search Models app.
1. On the WTS, start a web browser and open https://www.sap.com/fiori-apps-library.
2. Choose All apps for SAP S/4HANA (Private Cloud and On-Premise).
3. Choose All apps.
4. In the Search field (at the top left), enter search models and press Enter.
5. Select Display Search Models / Manage Search Models.
6. In the App Details pane, choose Implementation Information.
7. Make sure to select the details for SAP S/4HANA 2023 FPS02 (On-Premise).
8. Expand Configuration.
9. Keep this browser window open for later reference (you may copy and paste some technical names from here).
In your SAP S/4HANA system, activate the ICF node relevant for the Manage Search Models app.
1. From the SAP Fiori apps reference library, you know that the relevant SAPUI5 ICF path is /sap/bc/ui5_ui5/sap/as_cds_schmods1.
2. Continue working in your SAP system using the train-## user.
3. Enter transaction SICF.
4. In the Service Name field, enter as_cds_schmods1 and choose Execute (F8).
5. Expand the /sap/bc/ui5_ui5/sap ICF path.
6. If the /sap/bc/ui5_ui5/sap/as_cds_schmods1 service is not active (indicated by a gray or blue color), perform the following steps:
  1. Right-click the service as_cds_schmods1 and choose Activate Service.
  2. In the popup, choose the Yes button on the left.
In your SAP S/4HANA system, register the SAP Gateway service relevant for the Manage Search Models app.
Note
For Package Assignment, choose Local Object.
1. From the SAP Fiori apps reference library, you know that the relevant SAP Gateway service is CA_AS_ENTSRCHCDSMODELER_SRV.
2. Continue working in your SAP system using the train-## user.
3. Enter transaction /IWFND/MAINT_SERVICE.
4. If the service CA_AS_ENTSRCHCDSMODELER_SRV (note the column External Service Name) is not registered, perform the following steps:
  1. Choose Add Service.
  2. Right of System Alias, select Co-Deployed. In the External Service Name field, enter CA_AS_ENTSRCHCDSMODELER_SRV. Choose Get Services (F8).
  3. Select the search result and choose Add Selected Services.
  4. In this training, we choose Local Object (instead of using a customer package).
  5. Keep all other fields on their default values and choose Continue (Enter).
  6. To confirm the message, choose Continue (Enter).
  7. Go Back.
Create a reference for the EnterpriseSearchModel tile and its target mapping in your catalog Catalog ##.
Note
Use the client-specific version of the SAP Fiori launchpad content manager.
1. From the SAP Fiori apps reference library, you know the following:
  - The App ID is F3036.
  - The relevant semantic object is EnterpriseSearchModel.
  - The relevant action is manage.
2. Continue working in your SAP system using the train-## user.
3. Enter transaction /UI2/FLPCM_CUST.
4. Ensure that the Catalogs tab is selected.
5. Search for your catalog Z_##_BC_UX200, for example, using the Search Catalogs field.
6. Select your catalog Z_##_BC_UX200.
7. At the bottom (area Content in Catalog...), choose Add Tiles/Target Mappings → Add Tiles/TMs to Selected Catalog.
8. In the Add Tiles/Target Mappings as References to Catalog... screen, enter F3036 into the Search Tiles/Target Mappings field and choose Go.
9. Select the line for semantic object EnterpriseSearchModel and action manage.
10. Choose Add Tile/TM Reference.
In your My Home, add the Enterprise Search Models tile from your Catalog ## catalog to your favorite apps and test the app.
1. Start or reload the SAP Fiori launchpad of your SAP system in a client of your choice.
2. In your My Home, navigate to the Apps → Favorites section.
3. Choose Add Apps.
4. In the App Finder, select your catalog Catalog ## (at the left).
5. Click Add to Page "My Home" (the + sign) beneath the Enterprise Search Models tile.
6. Choose Navigate to Home (the SAP logo in the upper left).
7. Note the Application is not configured. Find details in SAP Note2283716 message at the top.
Set up the Adaptation Transport Organizer (ATO) for key user tools (transaction S_ATO_SETUP) with default data.
1. Continue working in your SAP system using the train-## user.
2. Enter transaction S_ATO_SETUP.
3. Note the ATO status at the top (it should be not configured).
4. In the Actions section, choose Setup with default data.
5. Now the ATO status should have changed to configured.
6. Refresh the Manage Search Models app and confirm that the Application is not configured. Find details in SAP Note2283716 message does not show up anymore.
7. Use the Manage Search Models app as you see fit.

Result

You can launch the Manage Search Models app to manage CDS-based search models.

Configure Fact Sheet Apps

Graphical outline of the SAP Fiori System Landscape – Fact Sheet Apps

Fact sheet apps display contextual information and key facts about central objects used in business operations. Fact sheets are designed to be intuitive and harmonized. From a fact sheet area (tile), you can drill down into its details. You can easily navigate from one fact sheet to its related fact sheets. For example, you can navigate from a document to the related business partner or the master data.

From fact sheets, you can start transactions by navigating to transactional apps, or by accessing the back-end system directly. For example, from a document fact sheet, you can access the back-end system to display document details or edit the document in SAP GUI or Web Dynpro.

Figure shows labeled screenshot of Fact Sheet App Configuration

Like transactional apps, each fact sheet has an ICF node for the SAPUI5 application, which needs to be activated on the FES, and an SAP Gateway service in the BES, which needs to be registered on the FES. In addition, a search connector needs to be created for the search model.

Duplicate Search Connectors

In case there are two (or more) active search connectors with the same description, the FLP adds the word duplicate plus the technical connector name to the connector name in the search dropdown box. Examples of this are as follows:

Bank duplicate S4Q100~BANK_H~
Banks duplicate CD$ALL~ESH_U_BANK~

The _H in the name Bank duplicate S4Q100~BANK_H~ indicates the "traditional" ESH-based search connector, while the CD in the name Banks duplicate CD$ALL~ESH_U_BANK~ indicates a CDS-based search connector.

Figures shows menu options and code related to Resolve Duplicate Search Connectors

SAP Note 3007113 provides some background information and outlines two ways to handle this:

Deactivate one of the connectors
Change the description of one (or both) of the connectors

SAP Note 3122697 list known equivalences between classical search models and CDS views.

There is also a technology blog SAP Fiori for SAP S/4HANA – Resolving duplicate search objects on this topic available at https://community.sap.com/t5/technology-blogs-by-sap/sap-fiori-for-sap-s-4hana-resolving-duplicate-search-objects/ba-p/13494594.

Configure a Fact Sheet App

Business Example

Fact sheet apps are another type of possible app type(s) in SAP Fiori systems. In this exercise, you will configure the fact sheet app Bank (S/4HANA).

Note

In this exercise, when an object name or value contains ##, replace ## with the number your trainer assigned to you.

Task 1: Test the Search 1/3

Steps

Open the Search in the SAP Fiori launchpad of your SAP S/4HANA system. Can you search for Banks?
1. Start or reload the SAP Fiori launchpad of your SAP S/4HANA system in a client of your choice.
2. In the header, select Search.
3. Carefully note the options to search for Banks.

Result

Because of the two active search connectors for Banks, two options to search for Banks are offered:

Bank duplicate S4<Q|P>100~BANK_H~
Banks duplicate CD$ALL~ESH_U_BANK~

For the root cause, see SAP Note 3007113.

Task 2: Deactivate Duplicate Search Connector

Steps

Deactivate the "traditional" ESH-based search connector (the one with BANK_H in the name) using the Connector Administration Cockpit. Confirm that the CDS-based search connector for Banks is still active.
1. Log on to your SAP system using the train-## user.
2. Enter transaction ESH_COCKPIT.
3. In the Find in table field, enter bank_h and choose Find Connector.
4. In the leftmost column, select the line for the connector ID S4Q100~BANK_H~ resp. S4P100~BANK_H~.
5. Choose Actions → Deactivate.
6. In the Find in table field, enter u_bank~ and choose Find Connector.
7. Confirm that the search connector with connector ID CD$ALL~ESH_U_BANK~ is still active.

Result

You deactivated the "traditional" ESH-based search connector for Banks. The CDS-based search connector for Banks is still active.

Task 3: Test the Search 2/3

Steps

Search for Banks in the SAP Fiori launchpad of your SAP S/4HANA system. What happens when you select a search result?
1. Start or reload the SAP Fiori launchpad of your SAP S/4HANA system in a client of your choice.
2. In the header, select Search.
3. Select the data area Banks. In the Search field, enter an asterisk (*) and choose Enter.
4. Note the result list.

Result

Due to a missing target mapping, you cannot navigate further. The search results cannot be clicked.

Task 4: Enable the Bank (S/4HANA) App

Steps

In the SAP Fiori apps reference library, open the configuration details for the Bank (S/4HANA) app.
1. On the WTS, start a web browser and open https://www.sap.com/fiori-apps-library.
2. Choose All apps for SAP S/4HANA (Private Cloud and On-Premise).
3. Choose All apps.
4. In the Search field (at the top left), enter bank s/4hana and press Enter.
5. Select Bank (S/4HANA).
6. In the App Details pane, choose Implementation Information.
7. Make sure to select the details for SAP S/4HANA 2023 FPS02 (On-Premise).
8. Expand Configuration.
9. Keep this browser window open for later reference (you may copy and paste some technical names from here).
In your SAP S/4HANA system, activate the ICF node relevant for the Bank (S/4HANA) app.
1. From the SAP Fiori apps reference library, you know that the relevant SAPUI5 ICF path is /sap/bc/ui5_ui5/sap/fin_fs_bank.
2. Continue working in your SAP system using the train-## user.
3. Enter transaction SICF.
4. In the Service Name field, enter fin_fs_bank and choose Execute (F8).
5. Expand the /sap/bc/ui5_ui5/sap ICF path.
6. If the /sap/bc/ui5_ui5/sap/fin_fs_bank service is not active (indicated by a gray or blue color), perform the following steps:
  1. Right-click the service fin_fs_bank and choose Activate Service.
  2. In the popup, choose the left Yes button.
In your SAP S/4HANA system, register the SAP Gateway service relevant for the Bank (S/4HANA) app.
Note
For Package Assignment, choose Local Object.
1. From the SAP Fiori apps reference library, you know that the relevant SAP Gateway service is FCLM_BAM_FS_BANK_SRV.
2. Continue working in your SAP system using the train-## user.
3. Enter transaction /IWFND/MAINT_SERVICE.
4. If the service FCLM_BAM_FS_BANK_SRV (note the column External Service Name) is not registered, perform the following steps:
5. Choose Add Service.
6. Right of System Alias, select Co-Deployed. In the External Service Name field, enter FCLM_BAM_FS_BANK_SRV. Choose Get Services (F8).
7. Select the search result and choose Add Selected Services.
8. In this training, we choose Local Object (instead of using a customer package).
9. Keep all other fields on their default values and choose Continue (Enter).
10. To confirm the message, choose Continue (Enter).
11. Go Back.
Create a reference for the Bank (S/4HANA) target mapping in your catalog Catalog ##.
Note
Use the client-specific version of the SAP Fiori launchpad content manager.
1. From the SAP Fiori apps reference library, you know the following:
  - The App ID is F1760.
  - The relevant semantic object is Bank.
  - The relevant action is displayFactSheet.
2. Continue working in your SAP system using the train-## user.
3. Enter transaction /UI2/FLPCM_CUST.
4. Ensure that the Catalogs tab is selected.
5. Search for your catalog Z_##_BC_UX200, for example using the Search Catalogs field.
6. Select your catalog Z_##_BC_UX200.
7. At the bottom (area Content in Catalog...), choose Add Tiles/Target Mappings → Add Tiles/TMs to Selected Catalog.
8. In the Add Tiles/Target Mappings as References to Catalog... screen, enter F1760 into the Search Tiles/Target Mappings field and choose Go.
9. Select the line for the Bank semantic object and the displayFactSheet action.
10. Choose Add TM Reference.

Task 5: Test the Search 3/3

Steps

Search for Banks in the SAP Fiori launchpad of your SAP S/4HANA system again. Can you select a search result now?
1. Repeat the steps as described in the Test the Search 2/3 section.
2. You can now view the details for any bank available in the system.

Next lesson