SAP SQLM_API_GET_TOP_RECS_SNAPSHOT Function Module for SQL Monitor API: Get Top Records of Snapshot

Search SAP Function Modules

SQLM_API_GET_TOP_RECS_SNAPSHOT is a standard sqlm api get top recs snapshot SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for SQL Monitor API: Get Top Records of Snapshot 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 sqlm api get top recs snapshot FM, simply by entering the name SQLM_API_GET_TOP_RECS_SNAPSHOT into the relevant SAP transaction such as SE37 or SE38.

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

Function SQLM_API_GET_TOP_RECS_SNAPSHOT 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 'SQLM_API_GET_TOP_RECS_SNAPSHOT'"SQL Monitor API: Get Top Records of Snapshot
  EXPORTING
   I_SNAPSHOT_ID =  "
*  I_FILTER_REQUESTNAME_RANGE =  "
*  I_FILTER_REQUESTTYPE_RANGE =  "
*  I_FILTER_TABLENAME_RANGE =  "
*  I_FILTER_RUNLEVEL_RANGE =  "
*  I_FILTER_STMTKIND_RANGE =  "
*  I_FILTER_EXCLUDE_TECH_RECORDS = ' ' "
*  I_FILTER_INCLUDE_RANGE =  "
*  I_COMPUTE_STATISTICS = 'X' "
*  I_TOPREC_SPEC_MAXIMUM = C_TOP_REC_DEFAULT_MAX "
*  I_TOPREC_SPEC_ORDER = C_TOP_REC_ORDER_EXC "
*  I_TOPREC_SPEC_AGGREGATION_KIND = C_TOP_REC_AGGR_NONE "
*  I_TOPREC_SPEC_IGNORE_TECH_RECS = 'X' "
*  I_FILTER_PACKAGE_RANGE =  "
*  I_FILTER_OBJNAME_RANGE =  "
*  I_FILTER_OBJTYPE_RANGE =  "

 IMPORTING
   E_TOP_RECORDS =  "

EXCEPTIONS
   SQLM_API_FAILURE = 1 

.

IMPORTING Parameters details for SQLM_API_GET_TOP_RECS_SNAPSHOT

I_SNAPSHOT_ID -

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

I_FILTER_REQUESTNAME_RANGE -

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

I_FILTER_REQUESTTYPE_RANGE -

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

I_FILTER_TABLENAME_RANGE -

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

I_FILTER_RUNLEVEL_RANGE -

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

I_FILTER_STMTKIND_RANGE -

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

I_FILTER_EXCLUDE_TECH_RECORDS -

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

I_FILTER_INCLUDE_RANGE -

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

I_COMPUTE_STATISTICS -

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

I_TOPREC_SPEC_MAXIMUM -

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

I_TOPREC_SPEC_ORDER -

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

I_TOPREC_SPEC_AGGREGATION_KIND -

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

I_TOPREC_SPEC_IGNORE_TECH_RECS -

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

I_FILTER_PACKAGE_RANGE -

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

I_FILTER_OBJNAME_RANGE -

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

I_FILTER_OBJTYPE_RANGE -

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

EXPORTING Parameters details for SQLM_API_GET_TOP_RECS_SNAPSHOT

E_TOP_RECORDS -

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

EXCEPTIONS details

SQLM_API_FAILURE -

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

Copy and paste ABAP code example for SQLM_API_GET_TOP_RECS_SNAPSHOT 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 SQLM_API_GET_TOP_RECS_SNAPSHOT

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