SAP TREX_EXT_PROCESS_NLI_SEARCH Function Module for Executes a NLI search









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

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



Function TREX_EXT_PROCESS_NLI_SEARCH 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 'TREX_EXT_PROCESS_NLI_SEARCH'"Executes a NLI search
EXPORTING
I_RFC_DESTINATION = "RFC destination to TREX
I_SERIALIZED_SEARCH_OBJECT = "
I_INTERPRETATION_NUMBER = "
* I_RESULT_FROM = "
* I_RESULT_TO = "
* I_GNAV_ATTRIBUTES = "Attributes
* I_COMP_DESCR = "Description of the components
* I_RESULT = 0 "0: documents 1: table

IMPORTING
E_RETURN_CODE = "Return code
E_RETURN_TEXT = "Return text
E_RESULT_DOCS = "Result documents
E_RESULT_TABLE = "Result table
E_NO_OF_HITS = "Number of hits returned
E_NO_OF_ALL_HITS = "Total number of hits in index
E_INDEX_SIZE = "Number of documents in index
E_DISPLAY_ATTRIBUTES = "

EXCEPTIONS
CONVERSION_ERROR = 1 ERROR = 2
.



IMPORTING Parameters details for TREX_EXT_PROCESS_NLI_SEARCH

I_RFC_DESTINATION - RFC destination to TREX

Data type: TREX_RFC-RFC_DESTINATION
Optional: No
Call by Reference: Yes

I_SERIALIZED_SEARCH_OBJECT -

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

I_INTERPRETATION_NUMBER -

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

I_RESULT_FROM -

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

I_RESULT_TO -

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

I_GNAV_ATTRIBUTES - Attributes

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

I_COMP_DESCR - Description of the components

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

I_RESULT - 0: documents 1: table

Data type: TREX_RFC-BOOLEAN
Optional: Yes
Call by Reference: Yes

EXPORTING Parameters details for TREX_EXT_PROCESS_NLI_SEARCH

E_RETURN_CODE - Return code

Data type: TREX_RFC-RETURN_CODE
Optional: No
Call by Reference: Yes

E_RETURN_TEXT - Return text

Data type: TREX_RFC-RETURN_TEXT
Optional: No
Call by Reference: Yes

E_RESULT_DOCS - Result documents

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

E_RESULT_TABLE - Result table

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

E_NO_OF_HITS - Number of hits returned

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

E_NO_OF_ALL_HITS - Total number of hits in index

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

E_INDEX_SIZE - Number of documents in index

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

E_DISPLAY_ATTRIBUTES -

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

EXCEPTIONS details

CONVERSION_ERROR - Error during conversion to UTF-8

Data type:
Optional: No
Call by Reference: Yes

ERROR - Error see error message

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for TREX_EXT_PROCESS_NLI_SEARCH 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_return_code  TYPE TREX_RFC-RETURN_CODE, "   
lv_conversion_error  TYPE TREX_RFC, "   
lv_i_rfc_destination  TYPE TREX_RFC-RFC_DESTINATION, "   
lv_error  TYPE TREX_RFC, "   
lv_e_return_text  TYPE TREX_RFC-RETURN_TEXT, "   
lv_i_serialized_search_object  TYPE XSTRING, "   
lv_e_result_docs  TYPE TREXT_RESULT_DOCS, "   
lv_i_interpretation_number  TYPE I, "   
lv_i_result_from  TYPE I, "   
lv_e_result_table  TYPE DATA, "   
lv_i_result_to  TYPE I, "   
lv_e_no_of_hits  TYPE I, "   
lv_e_no_of_all_hits  TYPE I, "   
lv_i_gnav_attributes  TYPE TREXT_ATTRIBUTES, "   
lv_e_index_size  TYPE I, "   
lv_i_comp_descr  TYPE TREXT_COMP_DESCR, "   
lv_i_result  TYPE TREX_RFC-BOOLEAN, "   0
lv_e_display_attributes  TYPE TREXT_NLI_REQ_ATTRIBUTES. "   

  CALL FUNCTION 'TREX_EXT_PROCESS_NLI_SEARCH'  "Executes a NLI search
    EXPORTING
         I_RFC_DESTINATION = lv_i_rfc_destination
         I_SERIALIZED_SEARCH_OBJECT = lv_i_serialized_search_object
         I_INTERPRETATION_NUMBER = lv_i_interpretation_number
         I_RESULT_FROM = lv_i_result_from
         I_RESULT_TO = lv_i_result_to
         I_GNAV_ATTRIBUTES = lv_i_gnav_attributes
         I_COMP_DESCR = lv_i_comp_descr
         I_RESULT = lv_i_result
    IMPORTING
         E_RETURN_CODE = lv_e_return_code
         E_RETURN_TEXT = lv_e_return_text
         E_RESULT_DOCS = lv_e_result_docs
         E_RESULT_TABLE = lv_e_result_table
         E_NO_OF_HITS = lv_e_no_of_hits
         E_NO_OF_ALL_HITS = lv_e_no_of_all_hits
         E_INDEX_SIZE = lv_e_index_size
         E_DISPLAY_ATTRIBUTES = lv_e_display_attributes
    EXCEPTIONS
        CONVERSION_ERROR = 1
        ERROR = 2
. " TREX_EXT_PROCESS_NLI_SEARCH




ABAP code using 7.40 inline data declarations to call FM TREX_EXT_PROCESS_NLI_SEARCH

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 RETURN_CODE FROM TREX_RFC INTO @DATA(ld_e_return_code).
 
 
"SELECT single RFC_DESTINATION FROM TREX_RFC INTO @DATA(ld_i_rfc_destination).
 
 
"SELECT single RETURN_TEXT FROM TREX_RFC INTO @DATA(ld_e_return_text).
 
 
 
 
 
 
 
 
 
 
 
 
"SELECT single BOOLEAN FROM TREX_RFC INTO @DATA(ld_i_result).
 
 


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!