SAP UPX_KPI_API_GET_RENDER Function Module for Get planning render object









UPX_KPI_API_GET_RENDER is a standard upx kpi api get render SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Get planning render object 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 kpi api get render FM, simply by entering the name UPX_KPI_API_GET_RENDER into the relevant SAP transaction such as SE37 or SE38.

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



Function UPX_KPI_API_GET_RENDER 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_KPI_API_GET_RENDER'"Get planning render object
  EXPORTING
*  I_CHECK =  "Data Element for Domain BOOLE: TRUE (='X') and FALSE (=' ')
*  IT_DATA =  "UPX: Layout and Data - data only
*  IS_SPREADING =  "API Layout: Settings for distribution in the background
*  I_TREE_CHANM =  "Characteristic
*  IT_TREE =  "Hierarchy Tree
*  IT_KF_SCHEME =  "API Layout: keyfigure schema
*  I_AREA =  "Planning Area
*  I_PLEVEL =  "Planning level
*  I_LAYOUT =  "Parameter Group
*  IR_CUR_RENDER =  "Interface to layout-rendering
*  IT_LC_MAIN =  "API Layout: Lead Columns
*  IT_LC_TIME =  "API Layout: Lead Column Time Settings
*  IS_INFO =  "Additional Information
*  IT_COL_INFO =  "UPX: Layout Design - External API
*  IT_COL =  "UPX: Layout and Data - Columns
*  IT_ROW_INFO =  "UPX: Layout Design - External API
*  IT_ROW =  "UPX: Layout and Data - Row

 IMPORTING
   ER_RENDER =  "Table with BAPI Return Information
.



IMPORTING Parameters details for UPX_KPI_API_GET_RENDER

I_CHECK - Data Element for Domain BOOLE: TRUE (='X') and FALSE (=' ')

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

IT_DATA - UPX: Layout and Data - data only

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

IS_SPREADING - API Layout: Settings for distribution in the background

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

I_TREE_CHANM - Characteristic

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

IT_TREE - Hierarchy Tree

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

IT_KF_SCHEME - API Layout: keyfigure schema

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

I_AREA - Planning Area

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

I_PLEVEL - Planning level

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

I_LAYOUT - Parameter Group

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

IR_CUR_RENDER - Interface to layout-rendering

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

IT_LC_MAIN - API Layout: Lead Columns

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

IT_LC_TIME - API Layout: Lead Column Time Settings

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

IS_INFO - Additional Information

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

IT_COL_INFO - UPX: Layout Design - External API

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

IT_COL - UPX: Layout and Data - Columns

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

IT_ROW_INFO - UPX: Layout Design - External API

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

IT_ROW - UPX: Layout and Data - Row

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

EXPORTING Parameters details for UPX_KPI_API_GET_RENDER

ER_RENDER - Table with BAPI Return Information

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

Copy and paste ABAP code example for UPX_KPI_API_GET_RENDER 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_check  TYPE BOOLE_D, "   
lv_er_render  TYPE IF_UPX_LAYOUT_RENDER, "   
lv_it_data  TYPE UPX_API_YT_DATA, "   
lv_is_spreading  TYPE UPX_YS_API_LAY_SPREADING, "   
lv_i_tree_chanm  TYPE UPC_Y_CHANM, "   
lv_it_tree  TYPE UPX_YT_LAYOUT_TREE, "   
lv_it_kf_scheme  TYPE UPX_YT_API_LAY_KF_SCHEME, "   
lv_i_area  TYPE UPC_Y_AREA, "   
lv_i_plevel  TYPE UPC_Y_PLEVEL, "   
lv_i_layout  TYPE UPC_Y_PARAM, "   
lv_ir_cur_render  TYPE IF_UPX_LAYOUT_RENDER, "   
lv_it_lc_main  TYPE UPX_YT_API_LAY_LC_MAIN, "   
lv_it_lc_time  TYPE UPX_YT_API_LAY_LC_TIME, "   
lv_is_info  TYPE UPC_YS_API_INFO, "   
lv_it_col_info  TYPE UPX_API_YT_COL_INFO, "   
lv_it_col  TYPE UPX_API_YT_COL, "   
lv_it_row_info  TYPE UPX_API_YT_ROW_INFO, "   
lv_it_row  TYPE UPX_API_YT_ROW. "   

  CALL FUNCTION 'UPX_KPI_API_GET_RENDER'  "Get planning render object
    EXPORTING
         I_CHECK = lv_i_check
         IT_DATA = lv_it_data
         IS_SPREADING = lv_is_spreading
         I_TREE_CHANM = lv_i_tree_chanm
         IT_TREE = lv_it_tree
         IT_KF_SCHEME = lv_it_kf_scheme
         I_AREA = lv_i_area
         I_PLEVEL = lv_i_plevel
         I_LAYOUT = lv_i_layout
         IR_CUR_RENDER = lv_ir_cur_render
         IT_LC_MAIN = lv_it_lc_main
         IT_LC_TIME = lv_it_lc_time
         IS_INFO = lv_is_info
         IT_COL_INFO = lv_it_col_info
         IT_COL = lv_it_col
         IT_ROW_INFO = lv_it_row_info
         IT_ROW = lv_it_row
    IMPORTING
         ER_RENDER = lv_er_render
. " UPX_KPI_API_GET_RENDER




ABAP code using 7.40 inline data declarations to call FM UPX_KPI_API_GET_RENDER

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!