SAP UPARU_UI_REFRESH_DATA Function Module for Refresh planning layout data









UPARU_UI_REFRESH_DATA is a standard uparu ui refresh data SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Refresh planning layout 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 uparu ui refresh data FM, simply by entering the name UPARU_UI_REFRESH_DATA into the relevant SAP transaction such as SE37 or SE38.

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



Function UPARU_UI_REFRESH_DATA 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 'UPARU_UI_REFRESH_DATA'"Refresh planning layout data
  EXPORTING
   I_AREA =  "Planning Area
   I_PLEVEL =  "Planning level
   I_PPACKAGE =  "Planning Package
   I_LAYOUT =  "Parameter Group

 IMPORTING
   E_NBROWS =  "MAP-SEM: (Layout) Number of rows
   E_NBKYFCOL =  "MAP-SEM: (Layout) Number of key figure columns
   E_ATR_LOCK =  "Indicates whether the update of attributes is enabled
   E_DEL_LOCK =  "Indicates whether the deletion of the master data is allowed
   E_KYF_LOCK =  "Indicates whether key figures can be updated
   E_SUBRC =  "Return Value, Return Value After ABAP Statements

TABLES
   ETK_HEADER =  "MAP-SEM: (Layout) Header rows
   ETK_KYF_DATA =  "MAP-SEM: (Layout) Key figure contents
   ETK_DOC_FLAG =  "MAP-SEM: (Layout) Document Flag
   ETK_RETURN =  "MAP-SEM: Error returned messages
   ETK_HEADER_ATTR =  "MAP-SEM: (Layout) MD attributes associated to header row
   ETK_ROW_STS =  "MAP-SEM: (Layout) Row status
   ETK_LEADCOL_DATA =  "MAP-SEM: (Layout) Lead column contents
   ETK_LEADCOL_TEXT =  "MAP-SEM: (Layout) Text Per Row (Only for Complex Lead Columns)
   ETK_ATTRCOL_VALUE =  "MAP-SEM: (Layout) Attribute column possible values
   ETK_ATTRCOL_DATA =  "MAP-SEM: (Layout) Attribute column contents
   ETK_KYF_INFO =  "MAP-SEM: (Layout) Key figure informations
   ETK_KYF_COLCHAR =  "MAP-SEM: (Layout) Col. char. used to select key fig. value
.



IMPORTING Parameters details for UPARU_UI_REFRESH_DATA

I_AREA - Planning Area

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

I_PLEVEL - Planning level

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

I_PPACKAGE - Planning Package

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

I_LAYOUT - Parameter Group

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

EXPORTING Parameters details for UPARU_UI_REFRESH_DATA

E_NBROWS - MAP-SEM: (Layout) Number of rows

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

E_NBKYFCOL - MAP-SEM: (Layout) Number of key figure columns

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

E_ATR_LOCK - Indicates whether the update of attributes is enabled

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

E_DEL_LOCK - Indicates whether the deletion of the master data is allowed

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

E_KYF_LOCK - Indicates whether key figures can be updated

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

E_SUBRC - Return Value, Return Value After ABAP Statements

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

TABLES Parameters details for UPARU_UI_REFRESH_DATA

ETK_HEADER - MAP-SEM: (Layout) Header rows

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

ETK_KYF_DATA - MAP-SEM: (Layout) Key figure contents

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

ETK_DOC_FLAG - MAP-SEM: (Layout) Document Flag

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

ETK_RETURN - MAP-SEM: Error returned messages

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

ETK_HEADER_ATTR - MAP-SEM: (Layout) MD attributes associated to header row

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

ETK_ROW_STS - MAP-SEM: (Layout) Row status

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

ETK_LEADCOL_DATA - MAP-SEM: (Layout) Lead column contents

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

ETK_LEADCOL_TEXT - MAP-SEM: (Layout) Text Per Row (Only for Complex Lead Columns)

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

ETK_ATTRCOL_VALUE - MAP-SEM: (Layout) Attribute column possible values

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

ETK_ATTRCOL_DATA - MAP-SEM: (Layout) Attribute column contents

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

ETK_KYF_INFO - MAP-SEM: (Layout) Key figure informations

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

ETK_KYF_COLCHAR - MAP-SEM: (Layout) Col. char. used to select key fig. value

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

Copy and paste ABAP code example for UPARU_UI_REFRESH_DATA 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_i_area  TYPE UPC_AREA-AREA, "   
lv_e_nbrows  TYPE UPARU_YS_L_ROW_STS-ROW, "   
lt_etk_header  TYPE STANDARD TABLE OF UPARU_YS_L_HDRS, "   
lt_etk_kyf_data  TYPE STANDARD TABLE OF UPARU_YS_L_KYF_DATA, "   
lt_etk_doc_flag  TYPE STANDARD TABLE OF UPARU_YS_L_DOC_FLAG, "   
lt_etk_return  TYPE STANDARD TABLE OF BAPIRET2, "   
lv_i_plevel  TYPE UPC_PLEVEL-PLEVEL, "   
lv_e_nbkyfcol  TYPE UPARU_YS_L_KYF_INFO-COL, "   
lt_etk_header_attr  TYPE STANDARD TABLE OF UPARU_YS_L_HDR_ATTRS, "   
lv_e_atr_lock  TYPE UPARU_TC_RLSSTS-ATR_UPD, "   
lv_i_ppackage  TYPE UPC_PACKAGE-PPACKAGE, "   
lt_etk_row_sts  TYPE STANDARD TABLE OF UPARU_YS_L_ROW_STS, "   
lv_i_layout  TYPE UPP_PARAM-PARAM, "   
lv_e_del_lock  TYPE UPARU_TC_RLSSTS-MD_RMV, "   
lt_etk_leadcol_data  TYPE STANDARD TABLE OF UPARU_YS_L_LC_DATA, "   
lv_e_kyf_lock  TYPE UPARU_TC_RLSSTS-KYF_UPD, "   
lt_etk_leadcol_text  TYPE STANDARD TABLE OF UPC_YS_API_ROW_TXT, "   
lv_e_subrc  TYPE SY-SUBRC, "   
lt_etk_attrcol_value  TYPE STANDARD TABLE OF UPARU_YS_L_AC_VALUE, "   
lt_etk_attrcol_data  TYPE STANDARD TABLE OF UPARU_YS_L_AC_DATA, "   
lt_etk_kyf_info  TYPE STANDARD TABLE OF UPARU_YS_L_KYF_INFO, "   
lt_etk_kyf_colchar  TYPE STANDARD TABLE OF UPARU_YS_L_KYF_COLCHAR. "   

  CALL FUNCTION 'UPARU_UI_REFRESH_DATA'  "Refresh planning layout data
    EXPORTING
         I_AREA = lv_i_area
         I_PLEVEL = lv_i_plevel
         I_PPACKAGE = lv_i_ppackage
         I_LAYOUT = lv_i_layout
    IMPORTING
         E_NBROWS = lv_e_nbrows
         E_NBKYFCOL = lv_e_nbkyfcol
         E_ATR_LOCK = lv_e_atr_lock
         E_DEL_LOCK = lv_e_del_lock
         E_KYF_LOCK = lv_e_kyf_lock
         E_SUBRC = lv_e_subrc
    TABLES
         ETK_HEADER = lt_etk_header
         ETK_KYF_DATA = lt_etk_kyf_data
         ETK_DOC_FLAG = lt_etk_doc_flag
         ETK_RETURN = lt_etk_return
         ETK_HEADER_ATTR = lt_etk_header_attr
         ETK_ROW_STS = lt_etk_row_sts
         ETK_LEADCOL_DATA = lt_etk_leadcol_data
         ETK_LEADCOL_TEXT = lt_etk_leadcol_text
         ETK_ATTRCOL_VALUE = lt_etk_attrcol_value
         ETK_ATTRCOL_DATA = lt_etk_attrcol_data
         ETK_KYF_INFO = lt_etk_kyf_info
         ETK_KYF_COLCHAR = lt_etk_kyf_colchar
. " UPARU_UI_REFRESH_DATA




ABAP code using 7.40 inline data declarations to call FM UPARU_UI_REFRESH_DATA

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.

"SELECT single AREA FROM UPC_AREA INTO @DATA(ld_i_area).
 
"SELECT single ROW FROM UPARU_YS_L_ROW_STS INTO @DATA(ld_e_nbrows).
 
 
 
 
 
"SELECT single PLEVEL FROM UPC_PLEVEL INTO @DATA(ld_i_plevel).
 
"SELECT single COL FROM UPARU_YS_L_KYF_INFO INTO @DATA(ld_e_nbkyfcol).
 
 
"SELECT single ATR_UPD FROM UPARU_TC_RLSSTS INTO @DATA(ld_e_atr_lock).
 
"SELECT single PPACKAGE FROM UPC_PACKAGE INTO @DATA(ld_i_ppackage).
 
 
"SELECT single PARAM FROM UPP_PARAM INTO @DATA(ld_i_layout).
 
"SELECT single MD_RMV FROM UPARU_TC_RLSSTS INTO @DATA(ld_e_del_lock).
 
 
"SELECT single KYF_UPD FROM UPARU_TC_RLSSTS INTO @DATA(ld_e_kyf_lock).
 
 
"SELECT single SUBRC FROM SY INTO @DATA(ld_e_subrc).
 
 
 
 
 


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!