SAP DOCUMENT_MAINTAIN_INDEX Function Module for Index a document

Search SAP Function Modules

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

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

Function DOCUMENT_MAINTAIN_INDEX 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 'DOCUMENT_MAINTAIN_INDEX'"Index a document
  EXPORTING
   CLASS =  "Information class
   KEY_OF_DOCUMENT =  " Application-dependent key of the
*  LANGUAGE = 'D' "Language indicator
   TITLE_OF_DOCUMENT =  "Title of the document (new)

 IMPORTING
   NUMBER_OF_ATTRIBUTES =  "Number of edited attributes
   NUMBER_OF_WORDS =  "Number of edited words

TABLES
   ATTRIBUTES_NEW =  "New values of the attributes
   ATTRIBUTES_OLD =  "Original, already indexed attribut
   TEXT_NEW =  "New text to be indexed
   TEXT_OLD =  "Old, already indexed text

EXCEPTIONS
   ATTRIBUTE_INVALID = 1    ATTRIBUTES_NEW_MISSING = 2    CLASS_INVALID = 3    DOCUMENT_ALREADY_REGISTERED = 4    DOCUMENT_NOT_REGISTERED = 5    INTERN_ERROR = 6    TEXT_NEW_MISSING = 7 

.

IMPORTING Parameters details for DOCUMENT_MAINTAIN_INDEX

CLASS - Information class

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

KEY_OF_DOCUMENT - Application-dependent key of the

Data type:
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)

TITLE_OF_DOCUMENT - Title of the document (new)

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

EXPORTING Parameters details for DOCUMENT_MAINTAIN_INDEX

NUMBER_OF_ATTRIBUTES - Number of edited attributes

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

NUMBER_OF_WORDS - Number of edited words

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

TABLES Parameters details for DOCUMENT_MAINTAIN_INDEX

ATTRIBUTES_NEW - New values of the attributes

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

ATTRIBUTES_OLD - Original, already indexed attribut

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

TEXT_NEW - New text to be indexed

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

TEXT_OLD - Old, already indexed text

Data type: TLINE
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)

ATTRIBUTES_NEW_MISSING - No new attributes specified.

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)

DOCUMENT_ALREADY_REGISTERED - Document is already recorded.

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

DOCUMENT_NOT_REGISTERED - Document is not recorded.

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)

TEXT_NEW_MISSING - No new text specified.

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

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

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