SAP UPX_LAYOUT_API_SETTINGS Function Module for Read the setting for the particular layout









UPX_LAYOUT_API_SETTINGS is a standard upx layout api settings SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read the setting for the particular layout 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 upx layout api settings FM, simply by entering the name UPX_LAYOUT_API_SETTINGS into the relevant SAP transaction such as SE37 or SE38.

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



Function UPX_LAYOUT_API_SETTINGS 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 'UPX_LAYOUT_API_SETTINGS'"Read the setting for the particular layout
  EXPORTING
   I_AREA =  "Planning Area
   I_PLEVEL =  "Planning Level
   I_LAYOUT =  "Parameter group
   IS_INFO =  "Additional information

 IMPORTING
   E_GUID =  "UPX: GUID of the Class Instance
   ES_SPREADING =  "API Structure Layout: Background Spreading Settings

TABLES
*  IT_HEAD_INFO =  "API: Information on Header Characteristics
*  ET_KF_SHIFT =  "API Structure Layout: Key Figure Shifts
*  ET_KF_PARAM =  "Layout API: Key Figure Scheme (Function Parameters)
*  ET_KF_TEXT =  "Texts for Key Figure Schemes
*  ET_LC_MAIN =  "API Structure Layout: Lead Columns Main Settings
*  ET_LC_TIME =  "API Structure Layout: Lead Columns Time Settings
*  ET_LC_TEXT =  "Configuration of Lead Columns: Text Table
*  ET_RETURN =  "Table with BAPI Return Information
   IT_ROW_INFO =  "API: Information on Row Characteristics
   IT_ROW =  "Description of Lines
   IT_COL_INFO =  "API: Information on Column Characteristics
   IT_COL =  "Column description
   IT_COL_TEXT =  "Data Column Headers
*  ET_HD_SCHEME =  "Lead Columns: Screen Field - Second Table
*  ET_HD_TEXT =  "HEAD Texts
*  ET_KF_SCHEME =  "API Structure Layout: Key Figure Scheme
.



IMPORTING Parameters details for UPX_LAYOUT_API_SETTINGS

I_AREA - Planning Area

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

I_PLEVEL - Planning Level

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

I_LAYOUT - Parameter group

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

IS_INFO - Additional information

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

EXPORTING Parameters details for UPX_LAYOUT_API_SETTINGS

E_GUID - UPX: GUID of the Class Instance

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

ES_SPREADING - API Structure Layout: Background Spreading Settings

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

TABLES Parameters details for UPX_LAYOUT_API_SETTINGS

IT_HEAD_INFO - API: Information on Header Characteristics

Data type: UPC_YS_API_HEAD_INFO
Optional: Yes
Call by Reference: Yes

ET_KF_SHIFT - API Structure Layout: Key Figure Shifts

Data type: UPX_YS_API_LAY_KF_SHIFT
Optional: Yes
Call by Reference: Yes

ET_KF_PARAM - Layout API: Key Figure Scheme (Function Parameters)

Data type: UPX_YS_API_LAY_KF_PARAM
Optional: Yes
Call by Reference: Yes

ET_KF_TEXT - Texts for Key Figure Schemes

Data type: UPX_YS_API_LAY_KF_TEXT
Optional: Yes
Call by Reference: Yes

ET_LC_MAIN - API Structure Layout: Lead Columns Main Settings

Data type: UPX_YS_API_LAY_LC_MAIN
Optional: Yes
Call by Reference: Yes

ET_LC_TIME - API Structure Layout: Lead Columns Time Settings

Data type: UPX_YS_API_LAY_LC_TIME
Optional: Yes
Call by Reference: Yes

ET_LC_TEXT - Configuration of Lead Columns: Text Table

Data type: UPX_YS_API_LAY_LC_TEXT
Optional: Yes
Call by Reference: Yes

ET_RETURN - Table with BAPI Return Information

Data type: BAPIRETTAB
Optional: Yes
Call by Reference: Yes

IT_ROW_INFO - API: Information on Row Characteristics

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

IT_ROW - Description of Lines

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

IT_COL_INFO - API: Information on Column Characteristics

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

IT_COL - Column description

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

IT_COL_TEXT - Data Column Headers

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

ET_HD_SCHEME - Lead Columns: Screen Field - Second Table

Data type: UPX_YS_API_LAY_HD_SCHEME
Optional: Yes
Call by Reference: Yes

ET_HD_TEXT - HEAD Texts

Data type: UPX_YS_API_LAY_HD_TEXT
Optional: Yes
Call by Reference: Yes

ET_KF_SCHEME - API Structure Layout: Key Figure Scheme

Data type: UPX_YS_API_LAY_KF_SCHEME
Optional: Yes
Call by Reference: Yes

Copy and paste ABAP code example for UPX_LAYOUT_API_SETTINGS 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_e_guid  TYPE UPX_Y_GUID, "   
lv_i_area  TYPE UPC_Y_AREA, "   
lt_it_head_info  TYPE STANDARD TABLE OF UPC_YS_API_HEAD_INFO, "   
lt_et_kf_shift  TYPE STANDARD TABLE OF UPX_YS_API_LAY_KF_SHIFT, "   
lt_et_kf_param  TYPE STANDARD TABLE OF UPX_YS_API_LAY_KF_PARAM, "   
lt_et_kf_text  TYPE STANDARD TABLE OF UPX_YS_API_LAY_KF_TEXT, "   
lt_et_lc_main  TYPE STANDARD TABLE OF UPX_YS_API_LAY_LC_MAIN, "   
lt_et_lc_time  TYPE STANDARD TABLE OF UPX_YS_API_LAY_LC_TIME, "   
lt_et_lc_text  TYPE STANDARD TABLE OF UPX_YS_API_LAY_LC_TEXT, "   
lt_et_return  TYPE STANDARD TABLE OF BAPIRETTAB, "   
lv_i_plevel  TYPE UPC_Y_PLEVEL, "   
lt_it_row_info  TYPE STANDARD TABLE OF UPC_YS_API_ROW_INFO, "   
lv_es_spreading  TYPE UPX_YS_API_LAY_SPREADING, "   
lt_it_row  TYPE STANDARD TABLE OF UPC_YS_API_ROW, "   
lv_i_layout  TYPE UPC_Y_PARAM, "   
lv_is_info  TYPE UPC_YS_API_INFO, "   
lt_it_col_info  TYPE STANDARD TABLE OF UPC_YS_API_COL_INFO, "   
lt_it_col  TYPE STANDARD TABLE OF UPC_YS_API_COL, "   
lt_it_col_text  TYPE STANDARD TABLE OF UPC_YS_API_COL_TXT, "   
lt_et_hd_scheme  TYPE STANDARD TABLE OF UPX_YS_API_LAY_HD_SCHEME, "   
lt_et_hd_text  TYPE STANDARD TABLE OF UPX_YS_API_LAY_HD_TEXT, "   
lt_et_kf_scheme  TYPE STANDARD TABLE OF UPX_YS_API_LAY_KF_SCHEME. "   

  CALL FUNCTION 'UPX_LAYOUT_API_SETTINGS'  "Read the setting for the particular layout
    EXPORTING
         I_AREA = lv_i_area
         I_PLEVEL = lv_i_plevel
         I_LAYOUT = lv_i_layout
         IS_INFO = lv_is_info
    IMPORTING
         E_GUID = lv_e_guid
         ES_SPREADING = lv_es_spreading
    TABLES
         IT_HEAD_INFO = lt_it_head_info
         ET_KF_SHIFT = lt_et_kf_shift
         ET_KF_PARAM = lt_et_kf_param
         ET_KF_TEXT = lt_et_kf_text
         ET_LC_MAIN = lt_et_lc_main
         ET_LC_TIME = lt_et_lc_time
         ET_LC_TEXT = lt_et_lc_text
         ET_RETURN = lt_et_return
         IT_ROW_INFO = lt_it_row_info
         IT_ROW = lt_it_row
         IT_COL_INFO = lt_it_col_info
         IT_COL = lt_it_col
         IT_COL_TEXT = lt_it_col_text
         ET_HD_SCHEME = lt_et_hd_scheme
         ET_HD_TEXT = lt_et_hd_text
         ET_KF_SCHEME = lt_et_kf_scheme
. " UPX_LAYOUT_API_SETTINGS




ABAP code using 7.40 inline data declarations to call FM UPX_LAYOUT_API_SETTINGS

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



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!