SAP STU3_ADMIN_CALL_SAPCL Function Module for Call DB2 IFI data collector stored procedure









STU3_ADMIN_CALL_SAPCL is a standard stu3 admin call sapcl SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Call DB2 IFI data collector stored procedure 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 stu3 admin call sapcl FM, simply by entering the name STU3_ADMIN_CALL_SAPCL into the relevant SAP transaction such as SE37 or SE38.

Function Group: STU3_ADMIN
Program Name: SAPLSTU3_ADMIN
Main Program: SAPLSTU3_ADMIN
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function STU3_ADMIN_CALL_SAPCL 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 'STU3_ADMIN_CALL_SAPCL'"Call DB2 IFI data collector stored procedure
  EXPORTING
*  MONITOR_PARAS =  "Char255
*  REMOTE_DBNAME =  "Logical name for a database connection
*  CLOSE_CON =  "Single-Character Flag
*  PERFORM_COMMIT =  "Single-Character Flag
*  REPORT_ERROR_TO_SYSLOG = ABAP_TRUE "

 IMPORTING
   SAPCL_RC =  "Natural number
   ERR_MSG =  "Character 1024

CHANGING
*  CON_REF =  "Database Connection

EXCEPTIONS
   ADBC_SQL_ERROR = 1    CONNECT_ERROR = 2    SAPCL_DOES_NOT_EXIST = 3
.



IMPORTING Parameters details for STU3_ADMIN_CALL_SAPCL

MONITOR_PARAS - Char255

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

REMOTE_DBNAME - Logical name for a database connection

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

CLOSE_CON - Single-Character Flag

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

PERFORM_COMMIT - Single-Character Flag

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

REPORT_ERROR_TO_SYSLOG -

Data type: ABAP_BOOL
Default: ABAP_TRUE
Optional: Yes
Call by Reference: Yes

EXPORTING Parameters details for STU3_ADMIN_CALL_SAPCL

SAPCL_RC - Natural number

Data type: INT4
Optional: No
Call by Reference: Yes

ERR_MSG - Character 1024

Data type: CHAR1024
Optional: No
Call by Reference: Yes

CHANGING Parameters details for STU3_ADMIN_CALL_SAPCL

CON_REF - Database Connection

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

EXCEPTIONS details

ADBC_SQL_ERROR -

Data type:
Optional: No
Call by Reference: Yes

CONNECT_ERROR -

Data type:
Optional: No
Call by Reference: Yes

SAPCL_DOES_NOT_EXIST -

Data type:
Optional: No
Call by Reference: Yes

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

DATA:
lv_con_ref  TYPE CL_SQL_CONNECTION, "   
lv_sapcl_rc  TYPE INT4, "   
lv_monitor_paras  TYPE CHAR255, "   
lv_adbc_sql_error  TYPE CHAR255, "   
lv_err_msg  TYPE CHAR1024, "   
lv_connect_error  TYPE CHAR1024, "   
lv_remote_dbname  TYPE DBCON_NAME, "   
lv_close_con  TYPE CHAR1, "   
lv_sapcl_does_not_exist  TYPE CHAR1, "   
lv_perform_commit  TYPE CHAR1, "   
lv_report_error_to_syslog  TYPE ABAP_BOOL. "   ABAP_TRUE

  CALL FUNCTION 'STU3_ADMIN_CALL_SAPCL'  "Call DB2 IFI data collector stored procedure
    EXPORTING
         MONITOR_PARAS = lv_monitor_paras
         REMOTE_DBNAME = lv_remote_dbname
         CLOSE_CON = lv_close_con
         PERFORM_COMMIT = lv_perform_commit
         REPORT_ERROR_TO_SYSLOG = lv_report_error_to_syslog
    IMPORTING
         SAPCL_RC = lv_sapcl_rc
         ERR_MSG = lv_err_msg
    CHANGING
         CON_REF = lv_con_ref
    EXCEPTIONS
        ADBC_SQL_ERROR = 1
        CONNECT_ERROR = 2
        SAPCL_DOES_NOT_EXIST = 3
. " STU3_ADMIN_CALL_SAPCL




ABAP code using 7.40 inline data declarations to call FM STU3_ADMIN_CALL_SAPCL

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.

 
 
 
 
 
 
 
 
 
 
DATA(ld_report_error_to_syslog) = ABAP_TRUE.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!