SAP ESH_DB_OVERVIEW Function Module for ES Dashboard: Overview Data

Search SAP Function Modules

ESH_DB_OVERVIEW is a standard esh db overview SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for ES Dashboard: Overview Data processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.

See here to view full function module documentation and code listing for esh db overview FM, simply by entering the name ESH_DB_OVERVIEW into the relevant SAP transaction such as SE37 or SE38.

Function Group: ESH_DB_DASHBOARD
Program Name: SAPLESH_DB_DASHBOARD
Main Program: SAPLESH_DB_DASHBOARD
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function ESH_DB_OVERVIEW pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.

CALL FUNCTION 'ESH_DB_OVERVIEW'"ES Dashboard: Overview Data
  EXPORTING
*  IV_DIAGNOSIS_LIST_ALL =  "List all checks, not only findings
*  IV_KPI_GET_ALL = 'X' "Get all available KPIs
*  IV_KPI_GET_DETAILS =  "Get detail data for requested KPIs
*  IT_KPI_SELECTION =  "List of requested KPIs
*  IV_KPI_TIME_RANGE = 'LAST_30_DAYS' "CL_ESH_QL_ANALYSIS=>GC_DATE_RANGE_*

 IMPORTING
   EV_STATUS =  "ES Dashboard: Application Status
   EV_REMOTE_SEARCH_ROLE =  "System Usage
   ET_SEARCH_TERMS =  "Freestyle Terms (up to char128)
   ET_UIS =  "Search Service
   ET_KPI =  "ES KPIs: KPI Results
   ET_DIAGNOSIS =  "Table with BAPI Return Information
   ES_RELEASE_DATA =  "ES Dashboard: Release Data
   ES_CONNECTION_DATA =  "ES Dashboard: Connection Data
   ES_IMPORT_STATUS_DATA =  "ES Dashboard: Import Status Data
   ES_CONNECTOR_DATA =  "ES Dashboard: Connector Data
   EV_RUNTIME_LOAD_STATUS =  "ES Dashboard: Status Runtime Load
   EV_ANONYMIZED_LOGGING =  "ESH: Is Anonymized Query Logging ON in Personalized Search
   ES_PS_POLICY_DATA =  "ES Dashboard: Personalized Search Policy Data

.

IMPORTING Parameters details for ESH_DB_OVERVIEW

IV_DIAGNOSIS_LIST_ALL - List all checks, not only findings

Data type: XFELD
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_KPI_GET_ALL - Get all available KPIs

Data type: XFELD
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_KPI_GET_DETAILS - Get detail data for requested KPIs

Data type: XFELD
Optional: Yes
Call by Reference: No ( called with pass by value option)

IT_KPI_SELECTION - List of requested KPIs

Data type: ESH_T_DB_KPI_ID
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_KPI_TIME_RANGE - CL_ESH_QL_ANALYSIS=>GC_DATE_RANGE_*

Data type: STRING
Default: 'LAST_30_DAYS'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for ESH_DB_OVERVIEW

EV_STATUS - ES Dashboard: Application Status

Data type: ESH_E_DB_STATUS
Optional: No
Call by Reference: No ( called with pass by value option)

EV_REMOTE_SEARCH_ROLE - System Usage

Data type: ESH_E_ADM_SYSTEM_USAGE
Optional: No
Call by Reference: No ( called with pass by value option)

ET_SEARCH_TERMS - Freestyle Terms (up to char128)

Data type: ESH_T_QM_FREESTYLE_TERMS
Optional: No
Call by Reference: No ( called with pass by value option)

ET_UIS - Search Service

Data type: ESH_T_QM_SEARCH_SERVICE
Optional: No
Call by Reference: No ( called with pass by value option)

ET_KPI - ES KPIs: KPI Results

Data type: ESH_T_DB_KPI_RESULT
Optional: No
Call by Reference: No ( called with pass by value option)

ET_DIAGNOSIS - Table with BAPI Return Information

Data type: BAPIRETTAB
Optional: No
Call by Reference: No ( called with pass by value option)

ES_RELEASE_DATA - ES Dashboard: Release Data

Data type: ESH_S_DB_RELEASE_DATA
Optional: No
Call by Reference: No ( called with pass by value option)

ES_CONNECTION_DATA - ES Dashboard: Connection Data

Data type: ESH_S_DB_CONNECTION_DATA
Optional: No
Call by Reference: No ( called with pass by value option)

ES_IMPORT_STATUS_DATA - ES Dashboard: Import Status Data

Data type: ESH_S_DB_IMPORT_STATUS_DATA
Optional: No
Call by Reference: No ( called with pass by value option)

ES_CONNECTOR_DATA - ES Dashboard: Connector Data

Data type: ESH_S_DB_CONNECTOR_DATA
Optional: No
Call by Reference: No ( called with pass by value option)

EV_RUNTIME_LOAD_STATUS - ES Dashboard: Status Runtime Load

Data type: ESH_E_DB_RTL_STATUS
Optional: No
Call by Reference: No ( called with pass by value option)

EV_ANONYMIZED_LOGGING - ESH: Is Anonymized Query Logging ON in Personalized Search

Data type: ESH_E_CU_PS_QL_ANONYM
Optional: No
Call by Reference: No ( called with pass by value option)

ES_PS_POLICY_DATA - ES Dashboard: Personalized Search Policy Data

Data type: ESH_S_DB_PS_POLICY_DATA
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for ESH_DB_OVERVIEW Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

ABAP code using 7.40 inline data declarations to call FM ESH_DB_OVERVIEW

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

Search for further information about these or an SAP related objects