SAP TREX_RFC_CLASSIFY_DOCUMENTS Function Module for Classifies documents: for each document an appropriate class is proposed









TREX_RFC_CLASSIFY_DOCUMENTS is a standard trex rfc 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 Classifies documents: for each document an appropriate class is proposed 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 rfc classify documents FM, simply by entering the name TREX_RFC_CLASSIFY_DOCUMENTS into the relevant SAP transaction such as SE37 or SE38.

Function Group: TREX_RFC_TM
Program Name: SAPLTREX_RFC_TM
Main Program: SAPLTREX_RFC_TM
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function TREX_RFC_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_RFC_CLASSIFY_DOCUMENTS'"Classifies documents: for each document an appropriate class is proposed
  EXPORTING
   INDEX_ID =  "IndexId
*  USE_KEYWORDS =  "Keywords are used
*  STAGING =  "Staging
*  LANGUAGE =  "Language
*  INDEXSERVER_LOCATION =  "Host:Port
*  THRESHOLD =  "Threshold
*  MAX_RESULTS =  "Number of results
*  CLASSIFY_ATTR =  "Classification attribute
*  CLASSIFY_METHOD =  "KNN, CENTROID, SAPMETHOD
*  CLASSIFY_TYPE =  "QUERY_BASED, EXAMPLE_BASED, TYPE_BOTH, TYPE_UNDEFINED
*  DOC_SEL_QUERY =  "DocumentSelectionQuery

 IMPORTING
   RETURN_CODE =  "Returncode
   RETURN_TEXT =  "Returntext

TABLES
   SEARCH_DOCS =  "Documents for Classification
   DOC_CONTENT =  "Content of the documents
*  DOC_ATTRIBUTES =  "Attributes of the documents
*  CLASSIFY_ATTRS =  "RAW: Requested Attributes
*  RESULT_CONTAINER =  "TextMiningResult contains several objects of type ResultElem
*  RESULT_ELEM =  "element of the TextMiningResultContainer
*  RESULT_PROPERTY =  "RAW: Result Element
.



IMPORTING Parameters details for TREX_RFC_CLASSIFY_DOCUMENTS

INDEX_ID - IndexId

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

USE_KEYWORDS - Keywords are used

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

STAGING - Staging

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

LANGUAGE - Language

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

INDEXSERVER_LOCATION - Host:Port

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

THRESHOLD - Threshold

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

MAX_RESULTS - Number of results

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

CLASSIFY_ATTR - Classification attribute

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

CLASSIFY_METHOD - KNN, CENTROID, SAPMETHOD

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

CLASSIFY_TYPE - QUERY_BASED, EXAMPLE_BASED, TYPE_BOTH, TYPE_UNDEFINED

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

DOC_SEL_QUERY - DocumentSelectionQuery

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

EXPORTING Parameters details for TREX_RFC_CLASSIFY_DOCUMENTS

RETURN_CODE - Returncode

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

RETURN_TEXT - Returntext

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

TABLES Parameters details for TREX_RFC_CLASSIFY_DOCUMENTS

SEARCH_DOCS - Documents for Classification

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

DOC_CONTENT - Content of the documents

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

DOC_ATTRIBUTES - Attributes of the documents

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

CLASSIFY_ATTRS - RAW: Requested Attributes

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

RESULT_CONTAINER - TextMiningResult contains several objects of type ResultElem

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

RESULT_ELEM - element of the TextMiningResultContainer

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

RESULT_PROPERTY - RAW: Result Element

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

Copy and paste ABAP code example for TREX_RFC_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.

DATA:
lv_index_id  TYPE TREXX_RFC-INDEX_ID, "   
lv_return_code  TYPE TREXX_RFC-RETURN_CODE, "   
lt_search_docs  TYPE STANDARD TABLE OF TREXX_RFC_SEARCH_DOCS, "   
lv_use_keywords  TYPE TREXX_RFC-FLAG, "   
lv_staging  TYPE TREXX_RFC-BOOLEAN, "   
lv_language  TYPE TREXX_RFC-LANGUAGE, "   
lt_doc_content  TYPE STANDARD TABLE OF TREXX_RFC_DOC_CONTENT, "   
lv_return_text  TYPE TREXX_RFC-RETURN_TEXT, "   
lt_doc_attributes  TYPE STANDARD TABLE OF TREXX_RFC_DOC_ATTRIBUTES, "   
lv_indexserver_location  TYPE TREXX_RFC-LOCATION, "   
lv_threshold  TYPE TREXX_RFC-NUMC, "   
lt_classify_attrs  TYPE STANDARD TABLE OF TREXX_RFC_REQ_ATTRIBUTES, "   
lv_max_results  TYPE TREXX_RFC-NUMC, "   
lt_result_container  TYPE STANDARD TABLE OF TREXX_RFC_RESULT_CONTAINER, "   
lt_result_elem  TYPE STANDARD TABLE OF TREXX_RFC_RESULT_ELEMENT, "   
lv_classify_attr  TYPE TREXX_RFC-CLASSIFY_ATTR, "   
lv_classify_method  TYPE TREXX_RFC-CLASSIFY_METHOD, "   
lt_result_property  TYPE STANDARD TABLE OF TREXX_RFC_RESULT_ELEMENT, "   
lv_classify_type  TYPE TREXX_RFC-CLASSIFY_TYPE, "   
lv_doc_sel_query  TYPE TREXX_RFC-DOC_SEL_QUERY. "   

  CALL FUNCTION 'TREX_RFC_CLASSIFY_DOCUMENTS'  "Classifies documents: for each document an appropriate class is proposed
    EXPORTING
         INDEX_ID = lv_index_id
         USE_KEYWORDS = lv_use_keywords
         STAGING = lv_staging
         LANGUAGE = lv_language
         INDEXSERVER_LOCATION = lv_indexserver_location
         THRESHOLD = lv_threshold
         MAX_RESULTS = lv_max_results
         CLASSIFY_ATTR = lv_classify_attr
         CLASSIFY_METHOD = lv_classify_method
         CLASSIFY_TYPE = lv_classify_type
         DOC_SEL_QUERY = lv_doc_sel_query
    IMPORTING
         RETURN_CODE = lv_return_code
         RETURN_TEXT = lv_return_text
    TABLES
         SEARCH_DOCS = lt_search_docs
         DOC_CONTENT = lt_doc_content
         DOC_ATTRIBUTES = lt_doc_attributes
         CLASSIFY_ATTRS = lt_classify_attrs
         RESULT_CONTAINER = lt_result_container
         RESULT_ELEM = lt_result_elem
         RESULT_PROPERTY = lt_result_property
. " TREX_RFC_CLASSIFY_DOCUMENTS




ABAP code using 7.40 inline data declarations to call FM TREX_RFC_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.

"SELECT single INDEX_ID FROM TREXX_RFC INTO @DATA(ld_index_id).
 
"SELECT single RETURN_CODE FROM TREXX_RFC INTO @DATA(ld_return_code).
 
 
"SELECT single FLAG FROM TREXX_RFC INTO @DATA(ld_use_keywords).
 
"SELECT single BOOLEAN FROM TREXX_RFC INTO @DATA(ld_staging).
 
"SELECT single LANGUAGE FROM TREXX_RFC INTO @DATA(ld_language).
 
 
"SELECT single RETURN_TEXT FROM TREXX_RFC INTO @DATA(ld_return_text).
 
 
"SELECT single LOCATION FROM TREXX_RFC INTO @DATA(ld_indexserver_location).
 
"SELECT single NUMC FROM TREXX_RFC INTO @DATA(ld_threshold).
 
 
"SELECT single NUMC FROM TREXX_RFC INTO @DATA(ld_max_results).
 
 
 
"SELECT single CLASSIFY_ATTR FROM TREXX_RFC INTO @DATA(ld_classify_attr).
 
"SELECT single CLASSIFY_METHOD FROM TREXX_RFC INTO @DATA(ld_classify_method).
 
 
"SELECT single CLASSIFY_TYPE FROM TREXX_RFC INTO @DATA(ld_classify_type).
 
"SELECT single DOC_SEL_QUERY FROM TREXX_RFC INTO @DATA(ld_doc_sel_query).
 


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!