SAP TREX_EXT_CLASSIFY_DOCUMENTS Function Module for Classify Documents

Search SAP Function Modules

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

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

Function TREX_EXT_CLASSIFY_DOCUMENTS 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_CLASSIFY_DOCUMENTS'"Classify Documents
  EXPORTING
   I_INDEX_ID =  "Index Id
*  I_CLASSIFY_TYPE =  "Optional: 1: QUERY_BASED, 2:EXAMPLE_BASED, 3:TYPE_BOTH, 0:TYPE_UNKNOWN
*  I_DOC_SEL_QUERY =  "Optional: DocumentSelectionQuery
*  I_USE_KEYWORDS = '' "Optional: Keywords are used for Classification Call
*  I_STAGING = 0 "Staging, 0: false, 1: true
*  I_CLASSIFY_ATTRS =  "Classification attribute
   I_RFC_DESTINATION =  "RFC Destination
*  I_LANGUAGE =  "Language
   I_SEARCH_DOCS =  "Documents for Classification
*  I_INDEXSERVER_LOCATION =  "Host:Port
*  I_THRESHOLD =  "Threshold between 1 and 1000
*  I_MAX_RESULTS = '20' "Number of results
*  I_CLASSIFY_ATTR =  "Classification attribute (defines category for classification)
*  I_CLASSIFY_METHOD =  "KNN, CENTROID, SAPMETHOD

 IMPORTING
   E_RETURN_CODE =  "Returncode
   E_RETURN_TEXT =  "Returntext
   E_RESULT_CONTAINER =  "TMResultCont. contains several objects of type ResultElement

EXCEPTIONS
   CONVERSION_ERROR = 1    ERROR = 2 

.

IMPORTING Parameters details for TREX_EXT_CLASSIFY_DOCUMENTS

I_INDEX_ID - Index Id

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

I_CLASSIFY_TYPE - Optional: 1: QUERY_BASED, 2:EXAMPLE_BASED, 3:TYPE_BOTH, 0:TYPE_UNKNOWN

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

I_DOC_SEL_QUERY - Optional: DocumentSelectionQuery

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

I_USE_KEYWORDS - Optional: Keywords are used for Classification Call

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

I_STAGING - Staging, 0: false, 1: true

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

I_CLASSIFY_ATTRS - Classification attribute

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

I_RFC_DESTINATION - RFC Destination

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

I_LANGUAGE - Language

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

I_SEARCH_DOCS - Documents for Classification

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

I_INDEXSERVER_LOCATION - Host:Port

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

I_THRESHOLD - Threshold between 1 and 1000

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

I_MAX_RESULTS - Number of results

Data type: I
Default: '20'
Optional: Yes
Call by Reference: Yes

I_CLASSIFY_ATTR - Classification attribute (defines category for classification)

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

I_CLASSIFY_METHOD - KNN, CENTROID, SAPMETHOD

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

EXPORTING Parameters details for TREX_EXT_CLASSIFY_DOCUMENTS

E_RETURN_CODE - Returncode

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

E_RETURN_TEXT - Returntext

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

E_RESULT_CONTAINER - TMResultCont. contains several objects of type ResultElement

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

EXCEPTIONS details

CONVERSION_ERROR - Fehler beim Konvertieren nach utf8

Data type:
Optional: No
Call by Reference: Yes

ERROR - Fehler, siehe Fehlermeldung

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

Copy and paste ABAP code example for TREX_EXT_CLASSIFY_DOCUMENTS 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_CLASSIFY_DOCUMENTS

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