SAP Function Modules

comments icon Comments

TREX_EXT_GET_DOC_FEATURES SAP Function module - Get document features







TREX_EXT_GET_DOC_FEATURES is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name TREX_EXT_GET_DOC_FEATURES into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: TREX_EXT_TM
Released Date: Not Released
Processing type: Normal fucntion module
Normal function module settings


Pattern for FM TREX_EXT_GET_DOC_FEATURES - TREX EXT GET DOC FEATURES 





CALL FUNCTION 'TREX_EXT_GET_DOC_FEATURES' "Get document features
  EXPORTING
    i_index_id =                " trex_rfc-index_id  Index Id
    i_rfc_destination =         " trex_rfc-rfc_destination  RFC Destination
*   i_language =                " trex_rfc-language  Language
*   i_indexserver_location =    " trex_rfc-location  Host:Port
*   i_doc_sel_query =           " trex_rfc-doc_sel_query  DocumentSelection Query
    i_search_docs =             " trext_search_docs  Document for document features
*   i_max_results = 20          " i             Maximum number of results
    i_staging = 0               " trex_rfc-boolean  Staging, 0: false, 1: true
  IMPORTING
    e_return_code =             " trex_rfc-return_code  Returncode
    e_return_text =             " trex_rfc-return_text  Returntext
    e_result_container =        " trext_result_container  TextMiningResult contains several objects of type ResultElem
  EXCEPTIONS
    CONVERSION_ERROR = 1        "               Error during conversion from/to UTF-8
    ERROR = 2                   "               Error, see error message
    .  "  TREX_EXT_GET_DOC_FEATURES

ABAP code example for Function Module TREX_EXT_GET_DOC_FEATURES





The ABAP code below is a full code listing to execute function module TREX_EXT_GET_DOC_FEATURES including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_e_return_code    TYPE TREX_RFC-RETURN_CODE
,
ld_e_return_text    TYPE TREX_RFC-RETURN_TEXT
,
ld_e_result_container    TYPE TREXT_RESULT_CONTAINER
.





DATA(ld_i_index_id) = some text here


DATA(ld_i_rfc_destination) = some text here


DATA(ld_i_language) = some text here


DATA(ld_i_indexserver_location) = some text here


DATA(ld_i_doc_sel_query) = some text here

DATA(ld_i_search_docs) = 'Check type of data required'.

DATA(ld_i_max_results) = 'Check type of data required'.


DATA(ld_i_staging) = Check type of data required
.

CALL FUNCTION 'TREX_EXT_GET_DOC_FEATURES'
  EXPORTING
    i_index_id =                 ld_i_index_id
    i_rfc_destination =          ld_i_rfc_destination
*   i_language =                 ld_i_language
*   i_indexserver_location =     ld_i_indexserver_location
*   i_doc_sel_query =            ld_i_doc_sel_query
    i_search_docs =              ld_i_search_docs
*   i_max_results =              ld_i_max_results
    i_staging =                  ld_i_staging
  IMPORTING
    e_return_code =              ld_e_return_code
    e_return_text =              ld_e_return_text
    e_result_container =         ld_e_result_container
  EXCEPTIONS
    CONVERSION_ERROR =           1
    ERROR =                      2
    .  "  TREX_EXT_GET_DOC_FEATURES

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ENDIF.







ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:


ld_e_return_code  TYPE TREX_RFC-RETURN_CODE ,
ld_i_index_id  TYPE TREX_RFC-INDEX_ID ,
ld_e_return_text  TYPE TREX_RFC-RETURN_TEXT ,
ld_i_rfc_destination  TYPE TREX_RFC-RFC_DESTINATION ,
ld_e_result_container  TYPE TREXT_RESULT_CONTAINER ,
ld_i_language  TYPE TREX_RFC-LANGUAGE ,
ld_i_indexserver_location  TYPE TREX_RFC-LOCATION ,
ld_i_doc_sel_query  TYPE TREX_RFC-DOC_SEL_QUERY ,
ld_i_search_docs  TYPE TREXT_SEARCH_DOCS ,
ld_i_max_results  TYPE I ,
ld_i_staging  TYPE TREX_RFC-BOOLEAN .





ld_i_index_id = some text here

ld_i_rfc_destination = some text here

ld_i_language = some text here

ld_i_indexserver_location = some text here

ld_i_doc_sel_query = some text here
ld_i_search_docs = 'Check type of data required'.
ld_i_max_results = 'Check type of data required'.

ld_i_staging = Check type of data required

Contribute (Add Comments)

Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name TREX_EXT_GET_DOC_FEATURES or its description.


   
 

TREX_EXT_GET_DOC_FEATURES - Get document features
TREX_EXT_GET_DOC_CONTENT - Get the content of documents in the TREX index
TREX_EXT_GET_DOCUMENT_LANGUAGE - Get document language
TREX_EXT_GET_DOCUMENTS_IN_QS - Get Documents in Queue
TREX_EXT_GET_DATA_STATS - get attributes statistics
TREX_EXT_GET_DATA_MATRIX - Get Data Matrix