SAP DOCUMENT_DELETE_INDEX Function Module for Delete indexes for a document









DOCUMENT_DELETE_INDEX is a standard document delete 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 Delete indexes for 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 delete index FM, simply by entering the name DOCUMENT_DELETE_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_DELETE_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_DELETE_INDEX'"Delete indexes for a document
EXPORTING
CLASS = "Information class
KEY_OF_DOCUMENT = " Application-dependent key of the
* LANGUAGE = 'D' "Language indicator

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

TABLES
ATTRIBUTES_OLD = "Original, already indexed values
TEXT_OLD = "Original, already indexed text

EXCEPTIONS
ATTRIBUTE_INVALID = 1 DOCUMENT_NOT_REGISTERED = 2 INTERN_ERROR = 3 TEXT_AND_ATTRIBUTES_MISSING = 4
.



IMPORTING Parameters details for DOCUMENT_DELETE_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)

EXPORTING Parameters details for DOCUMENT_DELETE_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_DELETE_INDEX

ATTRIBUTES_OLD - Original, already indexed values

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

TEXT_OLD - Original, 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)

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_AND_ATTRIBUTES_MISSING - No text and no attributes specifie

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

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

DATA:
lv_class  TYPE TFIC-CLASS, "   
lt_attributes_old  TYPE STANDARD TABLE OF ATVAL, "   
lv_attribute_invalid  TYPE ATVAL, "   
lv_number_of_attributes  TYPE FIST-HITS, "   
lt_text_old  TYPE STANDARD TABLE OF TLINE, "   
lv_key_of_document  TYPE TLINE, "   
lv_number_of_words  TYPE FIST-HITS, "   
lv_document_not_registered  TYPE FIST, "   
lv_language  TYPE SY-LANGU, "   'D'
lv_intern_error  TYPE SY, "   
lv_text_and_attributes_missing  TYPE SY. "   

  CALL FUNCTION 'DOCUMENT_DELETE_INDEX'  "Delete indexes for a document
    EXPORTING
         CLASS = lv_class
         KEY_OF_DOCUMENT = lv_key_of_document
         LANGUAGE = lv_language
    IMPORTING
         NUMBER_OF_ATTRIBUTES = lv_number_of_attributes
         NUMBER_OF_WORDS = lv_number_of_words
    TABLES
         ATTRIBUTES_OLD = lt_attributes_old
         TEXT_OLD = lt_text_old
    EXCEPTIONS
        ATTRIBUTE_INVALID = 1
        DOCUMENT_NOT_REGISTERED = 2
        INTERN_ERROR = 3
        TEXT_AND_ATTRIBUTES_MISSING = 4
. " DOCUMENT_DELETE_INDEX




ABAP code using 7.40 inline data declarations to call FM DOCUMENT_DELETE_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.

"SELECT single CLASS FROM TFIC INTO @DATA(ld_class).
 
 
 
"SELECT single HITS FROM FIST INTO @DATA(ld_number_of_attributes).
 
 
 
"SELECT single HITS FROM FIST INTO @DATA(ld_number_of_words).
 
 
"SELECT single LANGU FROM SY INTO @DATA(ld_language).
DATA(ld_language) = 'D'.
 
 
 


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!