SAP SF_SO_DOCUMENT_RETRIEVAL_BATCH Function Module for

Search SAP Function Modules

SF_SO_DOCUMENT_RETRIEVAL_BATCH is a standard sf so document retrieval batch SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 sf so document retrieval batch FM, simply by entering the name SF_SO_DOCUMENT_RETRIEVAL_BATCH into the relevant SAP transaction such as SE37 or SE38.

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

Function SF_SO_DOCUMENT_RETRIEVAL_BATCH 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 'SF_SO_DOCUMENT_RETRIEVAL_BATCH'"
  EXPORTING
   CLASS =  "Information class
*  LANGUAGE = 'D' "Language indicator
   REFINING_STEP =  "Indicator for refinement (='X')
*  SEARCH_IN_TITLE = ' ' "Request for search only in titles

 IMPORTING
   NUMBER_OF_HITS =  "Number of found documents
   NUMBER_OF_LOST_HITS =  "Number of pointers that cannot be

TABLES
   ATTRIBUTE_RESTRICTION =  "Predefined attribute restrictions
   KEY_TABLE =  "Document key (refinement and expor
   SEARCHTAB =  "Predefined search term
   TITLE_TABLE =  "Title of found documents

EXCEPTIONS
   ATTRIBUTE_INVALID = 1    WORD_INVALID = 10    ATTRIBUTE_RESTRICTION_INVALID = 2    CLASS_INVALID = 3    INTERN_ERROR = 4    KEY_INVALID = 5    LOGIC_INVALID = 6    REFINING_IMPOSSIBLE = 7    SEARCHTAB_EMPTY = 8    WORD_AND_LOGIC_INVALID = 9 

.

IMPORTING Parameters details for SF_SO_DOCUMENT_RETRIEVAL_BATCH

CLASS - Information class

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

LANGUAGE - Language indicator

Data type: SY-LANGU
Default: 'D'
Optional: Yes
Call by Reference: No ( called with pass by value option)

REFINING_STEP - Indicator for refinement (='X')

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

SEARCH_IN_TITLE - Request for search only in titles

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

EXPORTING Parameters details for SF_SO_DOCUMENT_RETRIEVAL_BATCH

NUMBER_OF_HITS - Number of found documents

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

NUMBER_OF_LOST_HITS - Number of pointers that cannot be

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

TABLES Parameters details for SF_SO_DOCUMENT_RETRIEVAL_BATCH

ATTRIBUTE_RESTRICTION - Predefined attribute restrictions

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

KEY_TABLE - Document key (refinement and expor

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

SEARCHTAB - Predefined search term

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

TITLE_TABLE - Title of found documents

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

EXCEPTIONS details

ATTRIBUTE_INVALID - Invalid attribute name.

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

WORD_INVALID - Invalid search term or operator.

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

ATTRIBUTE_RESTRICTION_INVALID - Invalid attribute restriction.

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

CLASS_INVALID - Invalid information class.

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

INTERN_ERROR - Internal error.

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

KEY_INVALID - Invalid document key.

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

LOGIC_INVALID - Logic error in search term.

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

REFINING_IMPOSSIBLE - Refinement not possible.

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

SEARCHTAB_EMPTY - Search term is empty.

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

WORD_AND_LOGIC_INVALID - Invalid search term or logic error

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

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

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