SAP TREX_EXT_CALCULATE_CLUSTERS Function Module for Calculate Clusters









TREX_EXT_CALCULATE_CLUSTERS is a standard trex ext calculate clusters SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Calculate Clusters 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 calculate clusters FM, simply by entering the name TREX_EXT_CALCULATE_CLUSTERS 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_CALCULATE_CLUSTERS 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_CALCULATE_CLUSTERS'"Calculate Clusters
  EXPORTING
   I_INDEX_ID =  "Index Id
*  I_SEARCH_DOCS =  "Document for document features
*  I_STAGING = 0 "Staging, 0: false, 1: true
   I_RFC_DESTINATION =  "RFC Destination
*  I_LANGUAGE =  "Language
*  I_INDEXSERVER_LOCATION =  "Host:Port
*  I_MAX_RESULTS = 20 "Maximum number of results
   I_CLUSTERING_ATTRIBUTE =  "Clustering Attribute
*  I_DOC_SEL_QUERY =  "DocumentSelection Query
*  I_CLUSTERING_METHOD = 4 "Clustering method
*  I_DOC_SIM_METHOD =  "Document similarity method

 IMPORTING
   E_RETURN_CODE =  "Return code
   E_RETURN_TEXT =  "Return text
   E_RESULT_CONTAINER =  "TResult Containers

EXCEPTIONS
   CONVERSION_ERROR = 1    ERROR = 2
.



IMPORTING Parameters details for TREX_EXT_CALCULATE_CLUSTERS

I_INDEX_ID - Index Id

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

I_SEARCH_DOCS - Document for document features

Data type: TREXT_SEARCH_DOCS
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_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_INDEXSERVER_LOCATION - Host:Port

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

I_MAX_RESULTS - Maximum number of results

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

I_CLUSTERING_ATTRIBUTE - Clustering Attribute

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

I_DOC_SEL_QUERY - DocumentSelection Query

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

I_CLUSTERING_METHOD - Clustering method

Data type: TREX_RFC-CLUSTERING_METHOD
Default: 4
Optional: Yes
Call by Reference: Yes

I_DOC_SIM_METHOD - Document similarity method

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

EXPORTING Parameters details for TREX_EXT_CALCULATE_CLUSTERS

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_CONTAINER - TResult Containers

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

EXCEPTIONS details

CONVERSION_ERROR - Error during conversion from/to UTF-8

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

ERROR - Error, see error message

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

Copy and paste ABAP code example for TREX_EXT_CALCULATE_CLUSTERS 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_i_index_id  TYPE TREX_RFC-INDEX_ID, "   
lv_e_return_code  TYPE TREX_RFC-RETURN_CODE, "   
lv_conversion_error  TYPE TREX_RFC, "   
lv_i_search_docs  TYPE TREXT_SEARCH_DOCS, "   
lv_i_staging  TYPE TREX_RFC-BOOLEAN, "   0
lv_error  TYPE TREX_RFC, "   
lv_e_return_text  TYPE TREX_RFC-RETURN_TEXT, "   
lv_i_rfc_destination  TYPE TREX_RFC-RFC_DESTINATION, "   
lv_i_language  TYPE TREX_RFC-LANGUAGE, "   
lv_e_result_container  TYPE TREXT_RESULT_CONTAINER, "   
lv_i_indexserver_location  TYPE TREX_RFC-LOCATION, "   
lv_i_max_results  TYPE I, "   20
lv_i_clustering_attribute  TYPE TREX_RFC-ATTRIBUTE, "   
lv_i_doc_sel_query  TYPE TREX_RFC-DOC_SEL_QUERY, "   
lv_i_clustering_method  TYPE TREX_RFC-CLUSTERING_METHOD, "   4
lv_i_doc_sim_method  TYPE TREX_RFC-DOC_SIM_METHOD. "   

  CALL FUNCTION 'TREX_EXT_CALCULATE_CLUSTERS'  "Calculate Clusters
    EXPORTING
         I_INDEX_ID = lv_i_index_id
         I_SEARCH_DOCS = lv_i_search_docs
         I_STAGING = lv_i_staging
         I_RFC_DESTINATION = lv_i_rfc_destination
         I_LANGUAGE = lv_i_language
         I_INDEXSERVER_LOCATION = lv_i_indexserver_location
         I_MAX_RESULTS = lv_i_max_results
         I_CLUSTERING_ATTRIBUTE = lv_i_clustering_attribute
         I_DOC_SEL_QUERY = lv_i_doc_sel_query
         I_CLUSTERING_METHOD = lv_i_clustering_method
         I_DOC_SIM_METHOD = lv_i_doc_sim_method
    IMPORTING
         E_RETURN_CODE = lv_e_return_code
         E_RETURN_TEXT = lv_e_return_text
         E_RESULT_CONTAINER = lv_e_result_container
    EXCEPTIONS
        CONVERSION_ERROR = 1
        ERROR = 2
. " TREX_EXT_CALCULATE_CLUSTERS




ABAP code using 7.40 inline data declarations to call FM TREX_EXT_CALCULATE_CLUSTERS

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 INDEX_ID FROM TREX_RFC INTO @DATA(ld_i_index_id).
 
"SELECT single RETURN_CODE FROM TREX_RFC INTO @DATA(ld_e_return_code).
 
 
 
"SELECT single BOOLEAN FROM TREX_RFC INTO @DATA(ld_i_staging).
 
 
"SELECT single RETURN_TEXT FROM TREX_RFC INTO @DATA(ld_e_return_text).
 
"SELECT single RFC_DESTINATION FROM TREX_RFC INTO @DATA(ld_i_rfc_destination).
 
"SELECT single LANGUAGE FROM TREX_RFC INTO @DATA(ld_i_language).
 
 
"SELECT single LOCATION FROM TREX_RFC INTO @DATA(ld_i_indexserver_location).
 
DATA(ld_i_max_results) = 20.
 
"SELECT single ATTRIBUTE FROM TREX_RFC INTO @DATA(ld_i_clustering_attribute).
 
"SELECT single DOC_SEL_QUERY FROM TREX_RFC INTO @DATA(ld_i_doc_sel_query).
 
"SELECT single CLUSTERING_METHOD FROM TREX_RFC INTO @DATA(ld_i_clustering_method).
DATA(ld_i_clustering_method) = 4.
 
"SELECT single DOC_SIM_METHOD FROM TREX_RFC INTO @DATA(ld_i_doc_sim_method).
 


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!