SAP SDOK_MUL_INDEX_SEARCH Function Module for Mul Searching API

Search SAP Function Modules

SDOK_MUL_INDEX_SEARCH is a standard sdok mul index search SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Mul Searching API 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 sdok mul index search FM, simply by entering the name SDOK_MUL_INDEX_SEARCH into the relevant SAP transaction such as SE37 or SE38.

Function Group: SRET_MUL_SEARCHING
Program Name: SAPLSRET_MUL_SEARCHING
Main Program: SAPLSRET_MUL_SEARCHING
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:

Function SDOK_MUL_INDEX_SEARCH 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 'SDOK_MUL_INDEX_SEARCH'"Mul Searching API
  EXPORTING
   DOCU' ' =  "Document Area
   LAISO =  "Language According to ISO 639 (2 Character)
   IV_TREX_REQ_GUID =  "Unique ID in space and time

 IMPORTING
   RCODE =  "Error number
   NUMOFHITS =  "No. of hits for a query
   ES_ERRORCODE =  "Transfer Structure: Error Code and Assigned Message

TABLES
   CATATTRIBUTTAB =  "Category attributes name - value
   QUERYPARAMTAB =  "Attributes for search request - service API
   QUERYTAB =  "Search request for a search engine
   TERMATTRTAB =  "Attributes of a search term in the search request
   DOCATTRTAB =  "Index attributes (attribute name and type) w/o error code
   RESULTDOCTAB =  "Document Hit List of Index Search
   RESULTATTRTAB =  "Document attribute with value
   PH_CLASS =  "SDOK: Class for information objects

EXCEPTIONS
   NO_DOCU_SPACE = 1    NO_RFC_DEST = 10    XERROR = 11    OTHERS = 12    NO_INDEX_CATEGORY = 2    CATID_UNKNOWN = 3    INTERN_ERROR = 4    PARAMETER_ERROR = 5    LANGUAGE_ERROR = 6    ATTRIBUTE_ERROR = 7    RFC_SYS_FAILURE = 8    RFC_COM_FAILURE = 9 

.

IMPORTING Parameters details for SDOK_MUL_INDEX_SEARCH

DOCUSPACE - Document Area

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

LAISO - Language According to ISO 639 (2 Character)

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

IV_TREX_REQ_GUID - Unique ID in space and time

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

EXPORTING Parameters details for SDOK_MUL_INDEX_SEARCH

RCODE - Error number

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

NUMOFHITS - No. of hits for a query

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

ES_ERRORCODE - Transfer Structure: Error Code and Assigned Message

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

TABLES Parameters details for SDOK_MUL_INDEX_SEARCH

CATATTRIBUTTAB - Category attributes name - value

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

QUERYPARAMTAB - Attributes for search request - service API

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

QUERYTAB - Search request for a search engine

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

TERMATTRTAB - Attributes of a search term in the search request

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

DOCATTRTAB - Index attributes (attribute name and type) w/o error code

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

RESULTDOCTAB - Document Hit List of Index Search

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

RESULTATTRTAB - Document attribute with value

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

PH_CLASS - SDOK: Class for information objects

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

EXCEPTIONS details

NO_DOCU_SPACE -

Data type:
Optional: No
Call by Reference: Yes

NO_RFC_DEST -

Data type:
Optional: No
Call by Reference: Yes

XERROR -

Data type:
Optional: No
Call by Reference: Yes

OTHERS -

Data type:
Optional: No
Call by Reference: Yes

NO_INDEX_CATEGORY -

Data type:
Optional: No
Call by Reference: Yes

CATID_UNKNOWN -

Data type:
Optional: No
Call by Reference: Yes

INTERN_ERROR -

Data type:
Optional: No
Call by Reference: Yes

PARAMETER_ERROR -

Data type:
Optional: No
Call by Reference: Yes

LANGUAGE_ERROR -

Data type:
Optional: No
Call by Reference: Yes

ATTRIBUTE_ERROR -

Data type:
Optional: No
Call by Reference: Yes

RFC_SYS_FAILURE -

Data type:
Optional: No
Call by Reference: Yes

RFC_COM_FAILURE -

Data type:
Optional: No
Call by Reference: Yes

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

ABAP code using 7.40 inline data declarations to call FM SDOK_MUL_INDEX_SEARCH

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.

Search for further information about these or an SAP related objects