SAP ICL_NAVIGATE Function Module for Navigation









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

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



Function ICL_NAVIGATE 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 'ICL_NAVIGATE'"Navigation
EXPORTING
* IV_VIEW = '~' "View
* IV_XTEST = "
* IV_SUBCL = '~' "Subclaim
* IV_CAT = "
* IV_ID = '~' "Navigation Node Subobject
* IV_XSELECT = 'X' "Select Node in Tree
* IV_XEXPAND = "Data Element for BOOLE Domain: TRUE (='X') and FALSE (=' ')
* IV_XPOPUP = "
* IV_XSTACK = 'X' "Navigation stack
* IV_SUBCL_CLAI = "

IMPORTING
EO_NODEREF = "FS CM: Navigation Tree for Claims

TABLES
* IT_CAT = "

EXCEPTIONS
NODE_NOT_FOUND = 1
.



IMPORTING Parameters details for ICL_NAVIGATE

IV_VIEW - View

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

IV_XTEST -

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

IV_SUBCL - Subclaim

Data type: ICL_NODEKEY-SUBCL
Default: '~'
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_CAT -

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

IV_ID - Navigation Node Subobject

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

IV_XSELECT - Select Node in Tree

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

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

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

IV_XPOPUP -

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

IV_XSTACK - Navigation stack

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

IV_SUBCL_CLAI -

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

EXPORTING Parameters details for ICL_NAVIGATE

EO_NODEREF - FS CM: Navigation Tree for Claims

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

TABLES Parameters details for ICL_NAVIGATE

IT_CAT -

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

EXCEPTIONS details

NODE_NOT_FOUND - Node Not Found

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

Copy and paste ABAP code example for ICL_NAVIGATE 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:
lt_it_cat  TYPE STANDARD TABLE OF STRING, "   
lv_iv_view  TYPE BU_SICHT, "   '~'
lv_eo_noderef  TYPE CL_NAVTREE_ICL, "   
lv_node_not_found  TYPE CL_NAVTREE_ICL, "   
lv_iv_xtest  TYPE BOOLE_D, "   
lv_iv_subcl  TYPE ICL_NODEKEY-SUBCL, "   '~'
lv_iv_cat  TYPE ICL_NODEKEY-CAT, "   
lv_iv_id  TYPE ICL_NODEKEY, "   '~'
lv_iv_xselect  TYPE BOOLE_D, "   'X'
lv_iv_xexpand  TYPE BOOLE_D, "   
lv_iv_xpopup  TYPE BOOLE_D, "   
lv_iv_xstack  TYPE BOOLE_D, "   'X'
lv_iv_subcl_clai  TYPE ICL_SUBCL. "   

  CALL FUNCTION 'ICL_NAVIGATE'  "Navigation
    EXPORTING
         IV_VIEW = lv_iv_view
         IV_XTEST = lv_iv_xtest
         IV_SUBCL = lv_iv_subcl
         IV_CAT = lv_iv_cat
         IV_ID = lv_iv_id
         IV_XSELECT = lv_iv_xselect
         IV_XEXPAND = lv_iv_xexpand
         IV_XPOPUP = lv_iv_xpopup
         IV_XSTACK = lv_iv_xstack
         IV_SUBCL_CLAI = lv_iv_subcl_clai
    IMPORTING
         EO_NODEREF = lv_eo_noderef
    TABLES
         IT_CAT = lt_it_cat
    EXCEPTIONS
        NODE_NOT_FOUND = 1
. " ICL_NAVIGATE




ABAP code using 7.40 inline data declarations to call FM ICL_NAVIGATE

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_iv_view) = '~'.
 
 
 
 
"SELECT single SUBCL FROM ICL_NODEKEY INTO @DATA(ld_iv_subcl).
DATA(ld_iv_subcl) = '~'.
 
"SELECT single CAT FROM ICL_NODEKEY INTO @DATA(ld_iv_cat).
 
DATA(ld_iv_id) = '~'.
 
DATA(ld_iv_xselect) = 'X'.
 
 
 
DATA(ld_iv_xstack) = 'X'.
 
 


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!