Activating Enterprise Search

Objective

After completing this lesson, you will be able to activate Enterprise Search

Activation of Enterprise Search

Configuration Area of the 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 Enterprise Search on HANA. With SAP HANA as a basis, the search directly accesses transactional database tables.

  • SAP HANA-enabled search models are available for important business objects. They have a simple, table-based structure, which enables a high performance in the determination of search results.

Configuration Flow of Enterprise Search

To enable the SAP Fiori search in the SAP Fiori launchpad, perform the steps described below. The search for business objects is enabled through corresponding search models.

SAP Fiori Search and Object Pages: The object page app does not require search models to work. However, if you want to start the app from search, you must activate the underlying search connectors.

Note

The setup of SAP Fiori search is a prerequisite for the use of object pages.
Running Task List SAP_ESH_RESET

The execution of task list, SAP_ESH_RESET, is an optional step. Use this task list to reset Enterprise Search-specific data and configuration. After the task is processed, Enterprise Search is in the delivery state.

Exception: Customer-specific models will not be deleted by default. To set the Enterprise Search into the delivery state without customer-specific models, you should deactivate the corresponding default setting in the parameter view of this task.

Running Task List SAP_ESH_INITIAL_SETUP_WRK_CLIENT

The task list, SAP_ESH_INITIAL_SETUP_WRK_CLIENT, provides the automatic initial setup of Enterprise Search in the work client. This can take a very long time, so start the task list in the background.

Caution

The task lists for enterprise search may consume an extreme amount of memory and may run several hours depending on the number of search connectors.

Note

Furthermore, see SAP Note 2626107How to execute task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT; this note also lists older SAP_BASIS releases where you have to execute task list SAP_ESH_INITIAL_SETUP_000_CLIENT in client 000 before executing task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT in the work client(s).

The user who executes the enterprise search setup tasks owns the administrator role SAP_ESH_LOCAL_ADMIN or a role which has at least all authority objects of the role SAP_ESH_LOCAL_ADMIN.

At the task with description Set TREX Destination or SAP HANA DB Connection, select Use SAP HANA Primary DB Connection: DEFAULT (in case of an SAP S/4HANA system). The SAP_ESH_INITIAL_SETUP_WRK_CLIENT task list is not specific to SAP S/4HANA systems – the options Use TREX and Use SAP HANA Secondary DB Connection (for SAP HANA as a sidecar) apply to SAP Business Suite systems. Fact sheet apps, however, require SAP HANA as database.

At the task with description, Select Models to Create Connectors, enter SAPAPPLH as Software Component (in case of an SAP S/4HANA system).

Note the job log of a job starting with STCTM_.

The execution of task list SAP_ESH_CREATE_INDEX_SC is an optional step. Use this task list to create and index search connectors – the tasks of task list SAP_ESH_CREATE_INDEX_SC are a subset of the tasks of task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT.

Report ESH_REFRESH_RUNTIME_BUFFER

After the task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT is completed, execute report ESH_REFRESH_RUNTIME_BUFFER to update the runtime buffer.

Activate Enterprise Search using Task List SAP_ESH_INITIAL_SETUP_WRK_CLIENT

Business Example

In this exercise, you will activate Enterprise Search, a prerequisite for SAP Fiori search.

Note

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

Task 1: Execute Task List SAP_ESH_INITIAL_SETUP_WRK_CLIENT

Steps

  1. In your SAP S/4HANA system, execute task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT (transaction STC01) in background mode with the following parametrization:

    • Set TREX Destination or SAP HANA DB Connection: Use SAP HANA Primary DB Connection: DEFAULT
    • Select Models to Create Connectors: SAPAPPLH
    1. Log on to your SAP system using the train-## user.

    2. Start transaction STC01.

    3. In the Task List field, select SAP_ESH_INITIAL_SETUP_WRK_CLIENT and select Generate Task List Run (F8).

    4. Select Fill Parameters for the task with description Set TREX Destination or SAP HANA DB Connection.

    5. On the Edit Variants screen, as Set TREX Destination or SAP HANA DB Connection, ensure that the option Use SAP HANA Primary DB Connection: DEFAULT is selected. Save this variant and select Back (F3).

    6. Select Fill Parameters for the task with description Select Models to Create Connectors.

    7. On the Edit Variants screen, as Software Component, choose SAPAPPLH (using the F4 help). Save this variant and choose Back (F3).

      Screenshot of the system to illustrate the sub-step
    8. Keep all other settings unchanged and press Start/Resume Task List Run in Background (F9).

    9. You may choose Auto (Set Auto Refresh Timer) to auto-refresh the task list run. Do not change the 60-second interval.

  2. While the task list SAP_ESH_INITIAL_SETUP_WRK_CLIENT is being executed, observe the background job processing and the memory consumption.

    1. To observe the background job, you can use transactions SMX or SM37. The name of the related job starts with STCTM_.

    2. To observe the memory consumption, you may use transaction ST02: note the value of SAP MemoryHeap memoryCurUse (make sure that you are connected to the processing application server instance; you may use transaction SM51 to switch to another application server instance).

      Expect a runtime of about 2 hours.
  3. Schedule report ESH_REFRESH_RUNTIME_BUFFER as background job, starting in 4 hours.

    1. Continue working in your SAP system using the train-## user.

    2. Start transaction SA38.

    3. In the Program field, enter ESH_REFRESH_RUNTIME_BUFFER.

    4. Choose Background.

    5. Choose Schedule.

    6. Enter any JobName, for example, ESH_REFRESH_RUNTIME_BUFFER.

    7. As Start Date, enter a date and time in about 4 hours.

      Hint

      The training system runs in UTC (Universal Time Coordinated).

    8. Choose Schedule once.

    9. At the next day, remember to check the job log and spool list of this background job.

Result

You performed an initial setup of Enterprise Search.

Log in to track your progress & complete quizzes