SAP COM_SE_INDEXER Function Module for Read objects and transfer them to the search engine (in parallel tasks)









COM_SE_INDEXER is a standard com se indexer SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read objects and transfer them to the search engine (in parallel tasks) 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 com se indexer FM, simply by entering the name COM_SE_INDEXER into the relevant SAP transaction such as SE37 or SE38.

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



Function COM_SE_INDEXER 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 'COM_SE_INDEXER'"Read objects and transfer them to the search engine (in parallel tasks)
  EXPORTING
   IV_INDEX_ID =  "Index ID in the Search Engine
*  IV_LET_BROKEN_LINKS_SURVIVE = ' ' "X = Let Broken Links Survive; ' ' = Delete Broken Links fom Index
*  IT_OBJ_IDS_DELETE =  "Object IDs to be deleted from the Index (deindexed)
*  IT_CHANGEPOINTER =  "Change Pointers related to the Object IDs
   IV_RFC_DESTINATION =  "RFC Destination to the Search Engine
   IV_BUSOBJ =  "Business Object of IT_OBJECT_IDS
   IV_OBJECT_TYPE =  "Type of Business Object
*  IT_OBJECT_IDS =  "Object IDs to be indexed
*  IT_ATTRIBUTE_NAMES =  "Attributes to be indexed
*  IV_MULTILANGUAGE = 'X' "X = Index the Objects in all available Languages
*  IV_LANGUAGE =  "ISO 639 Language, if only this Language is to be indexed
*  IV_FEED_INDEX = 'X' "X = Feed Index; ' ' = Only Read the Objects (Test Mode)

 IMPORTING
   EV_SE_IDX_RETURN_CODE =  "Return Code for Indexing in the Search Engine
   EV_SE_IDX_RETURN_TEXT =  "Return Text for Indexing in the Search Engine
   EV_SE_IDX_RUNTIME =  "Runtime of the Search Engine for Indexing
   EV_SE_DEL_RETURN_CODE =  "Return Code for Deletion in the Search Engine
   EV_SE_DEL_RETURN_TEXT =  "Return Text for Deletion in the Search Engine
   EV_SE_DEL_RUNTIME =  "Runtime of the Search Engine for Deletion
   ET_BROKEN_LINKS =  "Object IDs which are not available any more in the application

EXCEPTIONS
   BUSOBJ_METHOD_CALL_FAILED = 1    BUSOBJ_NOT_SUPPORTED = 2    BUSOBJ_OTHER_ERROR = 3    SE_METHOD_CALL_FAILED = 4    SE_CONVERSION_ERROR = 5    SE_OTHER_ERROR = 6
.



IMPORTING Parameters details for COM_SE_INDEXER

IV_INDEX_ID - Index ID in the Search Engine

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

IV_LET_BROKEN_LINKS_SURVIVE - X = Let Broken Links Survive; ' ' = Delete Broken Links fom Index

Data type: BOOLE_D
Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)

IT_OBJ_IDS_DELETE - Object IDs to be deleted from the Index (deindexed)

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

IT_CHANGEPOINTER - Change Pointers related to the Object IDs

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

IV_RFC_DESTINATION - RFC Destination to the Search Engine

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

IV_BUSOBJ - Business Object of IT_OBJECT_IDS

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

IV_OBJECT_TYPE - Type of Business Object

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

IT_OBJECT_IDS - Object IDs to be indexed

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

IT_ATTRIBUTE_NAMES - Attributes to be indexed

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

IV_MULTILANGUAGE - X = Index the Objects in all available Languages

Data type: COM_SEARCH_TV_MULTILANGUAGE
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_LANGUAGE - ISO 639 Language, if only this Language is to be indexed

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

IV_FEED_INDEX - X = Feed Index; ' ' = Only Read the Objects (Test Mode)

Data type: BOOLE_D
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for COM_SE_INDEXER

EV_SE_IDX_RETURN_CODE - Return Code for Indexing in the Search Engine

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

EV_SE_IDX_RETURN_TEXT - Return Text for Indexing in the Search Engine

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

EV_SE_IDX_RUNTIME - Runtime of the Search Engine for Indexing

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

EV_SE_DEL_RETURN_CODE - Return Code for Deletion in the Search Engine

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

EV_SE_DEL_RETURN_TEXT - Return Text for Deletion in the Search Engine

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

EV_SE_DEL_RUNTIME - Runtime of the Search Engine for Deletion

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

ET_BROKEN_LINKS - Object IDs which are not available any more in the application

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

EXCEPTIONS details

BUSOBJ_METHOD_CALL_FAILED - Dynamic Method Call for Business Object failed

Data type:
Optional: No
Call by Reference: Yes

BUSOBJ_NOT_SUPPORTED - Business Object is not supported (Table COM_SE_BUSOBJ)

Data type:
Optional: No
Call by Reference: Yes

BUSOBJ_OTHER_ERROR - Unspecified Error in Business Object Class

Data type:
Optional: No
Call by Reference: Yes

SE_METHOD_CALL_FAILED - Dynamic Method Call for Search Engine failed

Data type:
Optional: No
Call by Reference: Yes

SE_CONVERSION_ERROR - Search Engine: Error during Conversion to UTF-8

Data type:
Optional: No
Call by Reference: Yes

SE_OTHER_ERROR - Unspecified Error in Search Engine, see SYST-Variables

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for COM_SE_INDEXER 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_iv_index_id  TYPE TREX_RFC-INDEX_ID, "   
lv_ev_se_idx_return_code  TYPE TREX_RFC-RETURN_CODE, "   
lv_busobj_method_call_failed  TYPE TREX_RFC, "   
lv_iv_let_broken_links_survive  TYPE BOOLE_D, "   ' '
lv_it_obj_ids_delete  TYPE COM_SEARCH_TT_OBJECT_ID, "   
lv_it_changepointer  TYPE COM_SEARCH_TT_CPOINTER_PRIMKEY, "   
lv_iv_rfc_destination  TYPE TREX_RFC-RFC_DESTINATION, "   
lv_busobj_not_supported  TYPE TREX_RFC, "   
lv_ev_se_idx_return_text  TYPE TREX_RFC-RETURN_TEXT, "   
lv_iv_busobj  TYPE COM_SEARCH_TV_BUSOBJ, "   
lv_ev_se_idx_runtime  TYPE TREXS_COMPONENT_RUNTIME, "   
lv_busobj_other_error  TYPE TREXS_COMPONENT_RUNTIME, "   
lv_iv_object_type  TYPE COM_SEARCH_TV_OBJECT_TYPE, "   
lv_ev_se_del_return_code  TYPE TREX_RFC-RETURN_CODE, "   
lv_se_method_call_failed  TYPE TREX_RFC, "   
lv_it_object_ids  TYPE COM_SEARCH_TT_OBJECT_ID, "   
lv_se_conversion_error  TYPE COM_SEARCH_TT_OBJECT_ID, "   
lv_ev_se_del_return_text  TYPE TREX_RFC-RETURN_TEXT, "   
lv_se_other_error  TYPE TREX_RFC, "   
lv_ev_se_del_runtime  TYPE TREXS_COMPONENT_RUNTIME, "   
lv_it_attribute_names  TYPE COM_SEARCH_TT_ATTRIBUTE_NAME, "   
lv_et_broken_links  TYPE COM_SEARCH_TT_OBJECT_ID, "   
lv_iv_multilanguage  TYPE COM_SEARCH_TV_MULTILANGUAGE, "   'X'
lv_iv_language  TYPE LAISO, "   
lv_iv_feed_index  TYPE BOOLE_D. "   'X'

  CALL FUNCTION 'COM_SE_INDEXER'  "Read objects and transfer them to the search engine (in parallel tasks)
    EXPORTING
         IV_INDEX_ID = lv_iv_index_id
         IV_LET_BROKEN_LINKS_SURVIVE = lv_iv_let_broken_links_survive
         IT_OBJ_IDS_DELETE = lv_it_obj_ids_delete
         IT_CHANGEPOINTER = lv_it_changepointer
         IV_RFC_DESTINATION = lv_iv_rfc_destination
         IV_BUSOBJ = lv_iv_busobj
         IV_OBJECT_TYPE = lv_iv_object_type
         IT_OBJECT_IDS = lv_it_object_ids
         IT_ATTRIBUTE_NAMES = lv_it_attribute_names
         IV_MULTILANGUAGE = lv_iv_multilanguage
         IV_LANGUAGE = lv_iv_language
         IV_FEED_INDEX = lv_iv_feed_index
    IMPORTING
         EV_SE_IDX_RETURN_CODE = lv_ev_se_idx_return_code
         EV_SE_IDX_RETURN_TEXT = lv_ev_se_idx_return_text
         EV_SE_IDX_RUNTIME = lv_ev_se_idx_runtime
         EV_SE_DEL_RETURN_CODE = lv_ev_se_del_return_code
         EV_SE_DEL_RETURN_TEXT = lv_ev_se_del_return_text
         EV_SE_DEL_RUNTIME = lv_ev_se_del_runtime
         ET_BROKEN_LINKS = lv_et_broken_links
    EXCEPTIONS
        BUSOBJ_METHOD_CALL_FAILED = 1
        BUSOBJ_NOT_SUPPORTED = 2
        BUSOBJ_OTHER_ERROR = 3
        SE_METHOD_CALL_FAILED = 4
        SE_CONVERSION_ERROR = 5
        SE_OTHER_ERROR = 6
. " COM_SE_INDEXER




ABAP code using 7.40 inline data declarations to call FM COM_SE_INDEXER

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_iv_index_id).
 
"SELECT single RETURN_CODE FROM TREX_RFC INTO @DATA(ld_ev_se_idx_return_code).
 
 
DATA(ld_iv_let_broken_links_survive) = ' '.
 
 
 
"SELECT single RFC_DESTINATION FROM TREX_RFC INTO @DATA(ld_iv_rfc_destination).
 
 
"SELECT single RETURN_TEXT FROM TREX_RFC INTO @DATA(ld_ev_se_idx_return_text).
 
 
 
 
 
"SELECT single RETURN_CODE FROM TREX_RFC INTO @DATA(ld_ev_se_del_return_code).
 
 
 
 
"SELECT single RETURN_TEXT FROM TREX_RFC INTO @DATA(ld_ev_se_del_return_text).
 
 
 
 
 
DATA(ld_iv_multilanguage) = 'X'.
 
 
DATA(ld_iv_feed_index) = 'X'.
 


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!