SAP ABAP_DOCU_START Function Module for Initial Screen for ABAP Documentation, Search, and Display

Search SAP Function Modules

ABAP_DOCU_START is a standard abap docu start SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Initial Screen for ABAP Documentation, Search, and Display 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 abap docu start FM, simply by entering the name ABAP_DOCU_START into the relevant SAP transaction such as SE37 or SE38.

Function Group: ABAP_DOCU
Program Name: SAPLABAP_DOCU
Main Program: SAPLABAP_DOCU
Appliation area:
Release date: 14-Dec-2004
Mode(Normal, Remote etc): Normal Function Module
Update:

Function ABAP_DOCU_START 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 'ABAP_DOCU_START'"Initial Screen for ABAP Documentation, Search, and Display
  EXPORTING
*  WORD = '' "ABAP Term (Generic if Necessary)
*  FULL_TEXT_FLAG =  "Full Text Search
*  LANGU = SY-LANGU "Language for Full Text Search
*  DEBUG_FLAG = ' ' "Special Display Mode for Calls from ABAP Debugger
*  NO_SIMILARS = ' ' "No Similarity Search
*  FIRST_WORD = '' "First Word of Statement
*  TOKENS =  "All Tokens of Statement
*  MODE = ' ' "'ABAP' odr 'DYNP'
*  NO_DIALOG = ' ' "No Display of Selection List and Return of Table if 'X'
*  INDEX_FLAG = 'X' "Search in Index
*  GLOSSARY_FLAG = 'X' "Search in Glossary
*  SUBJECTS_FLAG = 'X' "Search in Keywords
*  EXAMPLES_FLAG = 'X' "Searching in Examples

 IMPORTING
   DOCU_CONTAINER =  "Reference to Docomentation or Hit List Container
   STRUCTURED_SEARCH_RESULTS =  "Structured Search Result
   SEARCH_RESULTS =  "Search Result if NO_DIALOG = 'X'

.

IMPORTING Parameters details for ABAP_DOCU_START

WORD - ABAP Term (Generic if Necessary)

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

FULL_TEXT_FLAG - Full Text Search

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

LANGU - Language for Full Text Search

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

DEBUG_FLAG - Special Display Mode for Calls from ABAP Debugger

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

NO_SIMILARS - No Similarity Search

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

FIRST_WORD - First Word of Statement

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

TOKENS - All Tokens of Statement

Data type: ABAPDOCU_TOKENS
Optional: Yes
Call by Reference: Yes

MODE - 'ABAP' odr 'DYNP'

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

NO_DIALOG - No Display of Selection List and Return of Table if 'X'

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

INDEX_FLAG - Search in Index

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

GLOSSARY_FLAG - Search in Glossary

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

SUBJECTS_FLAG - Search in Keywords

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

EXAMPLES_FLAG - Searching in Examples

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

EXPORTING Parameters details for ABAP_DOCU_START

DOCU_CONTAINER - Reference to Docomentation or Hit List Container

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

STRUCTURED_SEARCH_RESULTS - Structured Search Result

Data type: CL_ABAP_DOCU=>SEARCH_RESULTS
Optional: No
Call by Reference: Yes

SEARCH_RESULTS - Search Result if NO_DIALOG = 'X'

Data type: CL_ABAP_DOCU=>SEARCH_RESULTS
Optional: No
Call by Reference: Yes

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

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