TREX_EXT_GET_DOC_CONTENT SAP Function module - Get the content of documents in the TREX index

TREX_EXT_GET_DOC_CONTENT 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_CONTENT 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

Pattern for FM TREX_EXT_GET_DOC_CONTENT - TREX EXT GET DOC CONTENT

CALL FUNCTION 'TREX_EXT_GET_DOC_CONTENT' "Get the content of documents in the TREX index
  EXPORTING
    i_rfc_destination =         " trex_rfc-rfc_destination  RFC Destination
*   i_index_id =                " trex_rfc-index_id  Index Id
*   i_indexserver_location =    " trex_rfc-location  obsolete
*   i_request_flag = 1          " trex_rfc-request_content  1: originalContent 2:HighlightedContent 3:abstractContent4:preprocessDoc
*   i_search_docs =             " trext_search_docs  Documents
*   i_query_entries =           " trext_query_entries  Optional: Query entries for highlighting
*   i_content_request = 0       " trex_rfc-request_content  1: anchorlinks at top of document 2:hitpositions
*   i_highlighted_doc_part =    " trexd_attr_name  Attribute name
  IMPORTING
    e_result_docs =             " trext_result_docs  Result documents
    e_return_code =             " trex_rfc-return_code  Return code
    e_return_text =             " trex_rfc-return_text  Return text
    e_hit_positions =           " trext_hit_positions  hit position
  EXCEPTIONS
    CONVERSION_ERROR = 1        "               Error during conversion from/to UTF-8
    ERROR = 2                   "               Error, see error message
    .  "  TREX_EXT_GET_DOC_CONTENT

ABAP code example for Function Module TREX_EXT_GET_DOC_CONTENT

The ABAP code below is a full code listing to execute function module TREX_EXT_GET_DOC_CONTENT 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_result_docs  
 
 TYPE TREXT_RESULT_DOCS
,
ld_e_return_code  
 
 TYPE TREX_RFC-RETURN_CODE
,
ld_e_return_text  
 
 TYPE TREX_RFC-RETURN_TEXT
,
ld_e_hit_positions  
 
 TYPE TREXT_HIT_POSITIONS
.



DATA(ld_i_rfc_destination) = some text here


DATA(ld_i_index_id) = some text here


DATA(ld_i_indexserver_location) = some text here


DATA(ld_i_request_flag) = 123 

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

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


DATA(ld_i_content_request) = 123 

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

CALL FUNCTION 'TREX_EXT_GET_DOC_CONTENT'
  EXPORTING
    i_rfc_destination =          ld_i_rfc_destination
*   i_index_id =                 ld_i_index_id
*   i_indexserver_location =     ld_i_indexserver_location
*   i_request_flag =             ld_i_request_flag
*   i_search_docs =              ld_i_search_docs
*   i_query_entries =            ld_i_query_entries
*   i_content_request =          ld_i_content_request
*   i_highlighted_doc_part =     ld_i_highlighted_doc_part
  IMPORTING
    e_result_docs =              ld_e_result_docs
    e_return_code =              ld_e_return_code
    e_return_text =              ld_e_return_text
    e_hit_positions =            ld_e_hit_positions
  EXCEPTIONS
    CONVERSION_ERROR =           1
    ERROR =                      2
    .  "  TREX_EXT_GET_DOC_CONTENT

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_result_docs
 
 TYPE TREXT_RESULT_DOCS ,
ld_i_rfc_destination
 
 TYPE TREX_RFC-RFC_DESTINATION ,
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_indexserver_location
 
 TYPE TREX_RFC-LOCATION ,
ld_e_hit_positions
 
 TYPE TREXT_HIT_POSITIONS ,
ld_i_request_flag
 
 TYPE TREX_RFC-REQUEST_CONTENT ,
ld_i_search_docs
 
 TYPE TREXT_SEARCH_DOCS ,
ld_i_query_entries
 
 TYPE TREXT_QUERY_ENTRIES ,
ld_i_content_request
 
 TYPE TREX_RFC-REQUEST_CONTENT ,
ld_i_highlighted_doc_part
 
 TYPE TREXD_ATTR_NAME .



ld_i_rfc_destination = some text here

ld_i_index_id = some text here

ld_i_indexserver_location = some text here

ld_i_request_flag = 123 
ld_i_search_docs = 'Check type of data required'.
ld_i_query_entries = 'Check type of data required'.

ld_i_content_request = 123 
ld_i_highlighted_doc_part = 'Check type of data required'.