SAP UCLP_TREE_DISPLAY Function Module for









UCLP_TREE_DISPLAY is a standard uclp tree display SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 uclp tree display FM, simply by entering the name UCLP_TREE_DISPLAY into the relevant SAP transaction such as SE37 or SE38.

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



Function UCLP_TREE_DISPLAY 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 'UCLP_TREE_DISPLAY'"
  EXPORTING
   E_TITLE =  "
*  E_CALL_HEADER =  "Function Name
*  EO_CALLBACK =  "List Processor: Interface for Callback Definition
   ET_OPT_FCODE =  "List Processor: Display of Optional Menu Entries
*  E_CALLBACK_USER_COMMAND =  "Form
*  E_CALLBACK_RECURSE = ' ' "
*  E_CALLBACK_STATUS =  "Form
*  E_REPORT =  "
*  ET_RCALL =  "
*  E_FIELD_INFO_COMPLETE =  "
*  E_CPROG = SY-CPROG "ABAP Program, Caller in External Procedures
*  E_TAB_STRUCT =  "Table Name
*  E_DATUM =  "Date and Time, Current (Application Server) Date
*  E_UZEIT =  "Date and Time, Current Application Server Time
*  EO_MODEL =  "Model
*  E_USE_DYNPRO_OF_CALLER = ' ' "General Indicator for SAP Consolidation
*  ET_VAL_DERIV =  "List Processor: Value Derivation for Control Fields
*  E_CONSIST_CHECK = ' ' "
*  ET_CONTEXT =  "
*  ET_LAYOUT_OTHER =  "
*  EO_LOG =  "Log
   ET_LOG_OTHER =  "
*  E_HLP_STRUCT =  "Table Name
*  ET_DATA =  "
*  ET_LIST =  "List Properties
*  ET_FDISP =  "Fields contained in the list
*  ET_KDISP =  "
*  ET_KCORR =  "
*  E_CALL_HINFO =  "Function Name

CHANGING
*  C_DATA =  "
*  CT_WORK =  "
   CT_FFIX =  "
*  CT_FUSED =  "Fields used in listprocessor data table
*  CT_FUSED_FORKEY =  "
*  CT_TXTSHOW =  "
*  ET_BLIST =  "List Processor: Link Between List and Sublist
*  ET_MSG =  "List Processor: Messages for List

EXCEPTIONS
   DEP_ROLLNAME_NOT_FOUND = 1
.



IMPORTING Parameters details for UCLP_TREE_DISPLAY

E_TITLE -

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

E_CALL_HEADER - Function Name

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

EO_CALLBACK - List Processor: Interface for Callback Definition

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

ET_OPT_FCODE - List Processor: Display of Optional Menu Entries

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

E_CALLBACK_USER_COMMAND - Form

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

E_CALLBACK_RECURSE -

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

E_CALLBACK_STATUS - Form

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

E_REPORT -

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

ET_RCALL -

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

E_FIELD_INFO_COMPLETE -

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

E_CPROG - ABAP Program, Caller in External Procedures

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

E_TAB_STRUCT - Table Name

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

E_DATUM - Date and Time, Current (Application Server) Date

Data type: SY-DATUM
Optional: Yes
Call by Reference: Yes

E_UZEIT - Date and Time, Current Application Server Time

Data type: SY-UZEIT
Optional: Yes
Call by Reference: Yes

EO_MODEL - Model

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

E_USE_DYNPRO_OF_CALLER - General Indicator for SAP Consolidation

Data type: UC_FLG
Default: SPACE
Optional: Yes
Call by Reference: Yes

ET_VAL_DERIV - List Processor: Value Derivation for Control Fields

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

E_CONSIST_CHECK -

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

ET_CONTEXT -

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

ET_LAYOUT_OTHER -

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

EO_LOG - Log

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

ET_LOG_OTHER -

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

E_HLP_STRUCT - Table Name

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

ET_DATA -

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

ET_LIST - List Properties

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

ET_FDISP - Fields contained in the list

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

ET_KDISP -

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

ET_KCORR -

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

E_CALL_HINFO - Function Name

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

CHANGING Parameters details for UCLP_TREE_DISPLAY

C_DATA -

Data type:
Optional: Yes
Call by Reference: Yes

CT_WORK -

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

CT_FFIX -

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

CT_FUSED - Fields used in listprocessor data table

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

CT_FUSED_FORKEY -

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

CT_TXTSHOW -

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

ET_BLIST - List Processor: Link Between List and Sublist

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

ET_MSG - List Processor: Messages for List

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

EXCEPTIONS details

DEP_ROLLNAME_NOT_FOUND -

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

Copy and paste ABAP code example for UCLP_TREE_DISPLAY 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_c_data  TYPE STRING, "   
lv_e_title  TYPE C, "   
lv_dep_rollname_not_found  TYPE C, "   
lv_e_call_header  TYPE UC_LP_FUNCTION, "   
lv_eo_callback  TYPE IF_UC_LP_CALLBACK, "   
lv_et_opt_fcode  TYPE UCL_TS_LP_OPT_FCODE, "   
lv_e_callback_user_command  TYPE UC_LP_FORM, "   
lv_e_callback_recurse  TYPE UC_LP_FLG, "   ' '
lv_e_callback_status  TYPE UC_LP_FORM, "   
lv_e_report  TYPE RSTIREC, "   
lv_et_rcall  TYPE UCL_T_LP_RCALL, "   
lv_e_field_info_complete  TYPE UC_LP_FI_COMPLETE, "   
lv_e_cprog  TYPE SY-CPROG, "   SY-CPROG
lv_ct_work  TYPE TABLE, "   
lv_e_tab_struct  TYPE UC_LP_TABLE, "   
lv_e_datum  TYPE SY-DATUM, "   
lv_e_uzeit  TYPE SY-UZEIT, "   
lv_eo_model  TYPE IF_UC_MODEL, "   
lv_e_use_dynpro_of_caller  TYPE UC_FLG, "   SPACE
lv_et_val_deriv  TYPE UCL_TS_LP_VAL_DERIV, "   
lv_e_consist_check  TYPE UC_LP_FLG, "   SPACE
lv_et_context  TYPE UC0_TS_VALUE, "   
lv_et_layout_other  TYPE UCL_T_LOG_LAYOUT_OTHER, "   
lv_eo_log  TYPE CL_UC_LOG, "   
lv_et_log_other  TYPE UCL_TS_LOG_INFO, "   
lv_ct_ffix  TYPE UCL_T_LP_FFIX, "   
lv_e_hlp_struct  TYPE UC_LP_TABLE, "   
lv_et_data  TYPE TABLE, "   
lv_ct_fused  TYPE UCL_TS_LP_FUSED, "   
lv_et_list  TYPE UCL_T_LP_LIST, "   
lv_ct_fused_forkey  TYPE UCL_T_LP_FORKEY, "   
lv_et_fdisp  TYPE UCL_T_LP_FDISP, "   
lv_ct_txtshow  TYPE UCL_T_LP_TXTSHOW, "   
lv_et_blist  TYPE UCL_T_LP_BLIST, "   
lv_et_kdisp  TYPE UCL_T_LP_KDISP, "   
lv_et_msg  TYPE UCL_T_LP_MESSAGE, "   
lv_et_kcorr  TYPE UCL_T_LP_KCORR, "   
lv_e_call_hinfo  TYPE UC_LP_FUNCTION. "   

  CALL FUNCTION 'UCLP_TREE_DISPLAY'  "
    EXPORTING
         E_TITLE = lv_e_title
         E_CALL_HEADER = lv_e_call_header
         EO_CALLBACK = lv_eo_callback
         ET_OPT_FCODE = lv_et_opt_fcode
         E_CALLBACK_USER_COMMAND = lv_e_callback_user_command
         E_CALLBACK_RECURSE = lv_e_callback_recurse
         E_CALLBACK_STATUS = lv_e_callback_status
         E_REPORT = lv_e_report
         ET_RCALL = lv_et_rcall
         E_FIELD_INFO_COMPLETE = lv_e_field_info_complete
         E_CPROG = lv_e_cprog
         E_TAB_STRUCT = lv_e_tab_struct
         E_DATUM = lv_e_datum
         E_UZEIT = lv_e_uzeit
         EO_MODEL = lv_eo_model
         E_USE_DYNPRO_OF_CALLER = lv_e_use_dynpro_of_caller
         ET_VAL_DERIV = lv_et_val_deriv
         E_CONSIST_CHECK = lv_e_consist_check
         ET_CONTEXT = lv_et_context
         ET_LAYOUT_OTHER = lv_et_layout_other
         EO_LOG = lv_eo_log
         ET_LOG_OTHER = lv_et_log_other
         E_HLP_STRUCT = lv_e_hlp_struct
         ET_DATA = lv_et_data
         ET_LIST = lv_et_list
         ET_FDISP = lv_et_fdisp
         ET_KDISP = lv_et_kdisp
         ET_KCORR = lv_et_kcorr
         E_CALL_HINFO = lv_e_call_hinfo
    CHANGING
         C_DATA = lv_c_data
         CT_WORK = lv_ct_work
         CT_FFIX = lv_ct_ffix
         CT_FUSED = lv_ct_fused
         CT_FUSED_FORKEY = lv_ct_fused_forkey
         CT_TXTSHOW = lv_ct_txtshow
         ET_BLIST = lv_et_blist
         ET_MSG = lv_et_msg
    EXCEPTIONS
        DEP_ROLLNAME_NOT_FOUND = 1
. " UCLP_TREE_DISPLAY




ABAP code using 7.40 inline data declarations to call FM UCLP_TREE_DISPLAY

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_e_callback_recurse) = ' '.
 
 
 
 
 
"SELECT single CPROG FROM SY INTO @DATA(ld_e_cprog).
DATA(ld_e_cprog) = SY-CPROG.
 
 
 
"SELECT single DATUM FROM SY INTO @DATA(ld_e_datum).
 
"SELECT single UZEIT FROM SY INTO @DATA(ld_e_uzeit).
 
 
DATA(ld_e_use_dynpro_of_caller) = ' '.
 
 
DATA(ld_e_consist_check) = ' '.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 


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!