SAP TREX_EXT_INDEX Function Module for Index Documents

Search SAP Function Modules

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

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

Function TREX_EXT_INDEX 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_INDEX'"Index Documents
  EXPORTING
   I_INDEX_ID =  "IndexId
   I_RFC_DESTINATION =  "RFC Destination
*  I_INDEXSERVER_LOCATION =  "Host:Port
*  I_USE_QUEUESERVER = 'X' "Use QueueServer
*  I_KEEP_LUW = '' "Only for debugging: keep logical unit of work
*  I_FLUSH_AFTER_INDEX = '' "Flush documents after indexing
   I_INDEX_DOCUMENT_LIST =  "Documents for indexing
*  I_TRANSACTION_ID =  "obsolete
   I_AUTO_OPTIMIZE = 0 "1: Optimization is done after indexing

 IMPORTING
   E_RETURN_ERROR_DOC =  "Error documents
   E_RETURN_CODE =  "Return code
   E_RETURN_TEXT =  "Return text
   E_COMPONENT_RUNTIME =  "run time of the trex components

EXCEPTIONS
   CONVERSION_ERROR = 1    RFCSERVER_ERROR = 2    ERROR = 3 

.

IMPORTING Parameters details for TREX_EXT_INDEX

I_INDEX_ID - IndexId

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

I_RFC_DESTINATION - RFC Destination

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

I_INDEXSERVER_LOCATION - Host:Port

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

I_USE_QUEUESERVER - Use QueueServer

Data type: TREX_RFC-FLAG
Default: 'X'
Optional: Yes
Call by Reference: Yes

I_KEEP_LUW - Only for debugging: keep logical unit of work

Data type: TREX_RFC-FLAG
Default: ''
Optional: No
Call by Reference: Yes

I_FLUSH_AFTER_INDEX - Flush documents after indexing

Data type: TREX_RFC-FLAG
Default: ''
Optional: Yes
Call by Reference: Yes

I_INDEX_DOCUMENT_LIST - Documents for indexing

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

I_TRANSACTION_ID - obsolete

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

I_AUTO_OPTIMIZE - 1: Optimization is done after indexing

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

EXPORTING Parameters details for TREX_EXT_INDEX

E_RETURN_ERROR_DOC - Error documents

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

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_COMPONENT_RUNTIME - run time of the trex components

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

EXCEPTIONS details

CONVERSION_ERROR - Error during conversion to or from UTF-8

Data type:
Optional: No
Call by Reference: Yes

RFCSERVER_ERROR - TREXRfcServer Error

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_INDEX 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.

ABAP code using 7.40 inline data declarations to call FM TREX_EXT_INDEX

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