SAP ARCHIVE_OPEN_FOR_DELETE Function Module for Open Achive File to Delete Records in the Database









ARCHIVE_OPEN_FOR_DELETE is a standard archive open for delete SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Open Achive File to Delete Records in the Database 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 archive open for delete FM, simply by entering the name ARCHIVE_OPEN_FOR_DELETE into the relevant SAP transaction such as SE37 or SE38.

Function Group: ARCH
Program Name: SAPLARCH
Main Program: SAPLARCH
Appliation area: S
Release date: 11-Jan-1995
Mode(Normal, Remote etc): Normal Function Module
Update:



Function ARCHIVE_OPEN_FOR_DELETE 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 'ARCHIVE_OPEN_FOR_DELETE'"Open Achive File to Delete Records in the Database
EXPORTING
* ARCHIVE_NAME = ' ' "Archive File Name According to Archive Management
OBJECT = "Archiving Object Name
* TEST_MODE = ' ' "Test Mode Switch
* AINDFLAG = 'X' "
* NO_STATISTICS = ' ' "Switch for Statistics
* OUTPUT_SEL_SCREEN_WHEN_DIALOG = ' ' "If in Dialog Mode, Output Selection Screen
* OUTPUT_SEL_SCREEN_WHEN_BATCH = ' ' "If in Background, Output Selection Screen

IMPORTING
ARCHIVE_HANDLE = "Handle to the Open Files

TABLES
* SELECTED_FILES = "Table with the Selected Entries

EXCEPTIONS
FILE_ALREADY_OPEN = 1 FILE_IO_ERROR = 2 INTERNAL_ERROR = 3 NO_FILES_AVAILABLE = 4 OBJECT_NOT_FOUND = 5 OPEN_ERROR = 6 NOT_AUTHORIZED = 7 ARCHIVING_STANDARD_VIOLATION = 8
.



IMPORTING Parameters details for ARCHIVE_OPEN_FOR_DELETE

ARCHIVE_NAME - Archive File Name According to Archive Management

Data type: ADMI_FILES-ARCHIV_KEY
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

OBJECT - Archiving Object Name

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

TEST_MODE - Test Mode Switch

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

AINDFLAG -

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

NO_STATISTICS - Switch for Statistics

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

OUTPUT_SEL_SCREEN_WHEN_DIALOG - If in Dialog Mode, Output Selection Screen

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

OUTPUT_SEL_SCREEN_WHEN_BATCH - If in Background, Output Selection Screen

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

EXPORTING Parameters details for ARCHIVE_OPEN_FOR_DELETE

ARCHIVE_HANDLE - Handle to the Open Files

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

TABLES Parameters details for ARCHIVE_OPEN_FOR_DELETE

SELECTED_FILES - Table with the Selected Entries

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

EXCEPTIONS details

FILE_ALREADY_OPEN - The System Tried Repeatedly to Open a File

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

FILE_IO_ERROR - Archive File Access Error

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

INTERNAL_ERROR - Internal error

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

NO_FILES_AVAILABLE - No Files Exist for Object

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

OBJECT_NOT_FOUND - Object Unknown

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

OPEN_ERROR - Could not open file

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

NOT_AUTHORIZED - No Authorization for ARCHIVE_OPEN_FOR_DELETE

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

ARCHIVING_STANDARD_VIOLATION - Violation of the Archiving Standard

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for ARCHIVE_OPEN_FOR_DELETE 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_archive_name  TYPE ADMI_FILES-ARCHIV_KEY, "   SPACE
lv_archive_handle  TYPE SY-TABIX, "   
lt_selected_files  TYPE STANDARD TABLE OF ADMI_FILES, "   
lv_file_already_open  TYPE ADMI_FILES, "   
lv_object  TYPE ARCH_OBJ-OBJECT, "   
lv_file_io_error  TYPE ARCH_OBJ, "   
lv_test_mode  TYPE ARCH_OBJ, "   SPACE
lv_internal_error  TYPE ARCH_OBJ, "   
lv_aindflag  TYPE C, "   'X'
lv_no_files_available  TYPE C, "   
lv_no_statistics  TYPE C, "   SPACE
lv_object_not_found  TYPE C, "   
lv_open_error  TYPE C, "   
lv_output_sel_screen_when_dialog  TYPE C, "   SPACE
lv_not_authorized  TYPE C, "   
lv_output_sel_screen_when_batch  TYPE C, "   SPACE
lv_archiving_standard_violation  TYPE C. "   

  CALL FUNCTION 'ARCHIVE_OPEN_FOR_DELETE'  "Open Achive File to Delete Records in the Database
    EXPORTING
         ARCHIVE_NAME = lv_archive_name
         OBJECT = lv_object
         TEST_MODE = lv_test_mode
         AINDFLAG = lv_aindflag
         NO_STATISTICS = lv_no_statistics
         OUTPUT_SEL_SCREEN_WHEN_DIALOG = lv_output_sel_screen_when_dialog
         OUTPUT_SEL_SCREEN_WHEN_BATCH = lv_output_sel_screen_when_batch
    IMPORTING
         ARCHIVE_HANDLE = lv_archive_handle
    TABLES
         SELECTED_FILES = lt_selected_files
    EXCEPTIONS
        FILE_ALREADY_OPEN = 1
        FILE_IO_ERROR = 2
        INTERNAL_ERROR = 3
        NO_FILES_AVAILABLE = 4
        OBJECT_NOT_FOUND = 5
        OPEN_ERROR = 6
        NOT_AUTHORIZED = 7
        ARCHIVING_STANDARD_VIOLATION = 8
. " ARCHIVE_OPEN_FOR_DELETE




ABAP code using 7.40 inline data declarations to call FM ARCHIVE_OPEN_FOR_DELETE

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 ARCHIV_KEY FROM ADMI_FILES INTO @DATA(ld_archive_name).
DATA(ld_archive_name) = ' '.
 
"SELECT single TABIX FROM SY INTO @DATA(ld_archive_handle).
 
 
 
"SELECT single OBJECT FROM ARCH_OBJ INTO @DATA(ld_object).
 
 
DATA(ld_test_mode) = ' '.
 
 
DATA(ld_aindflag) = 'X'.
 
 
DATA(ld_no_statistics) = ' '.
 
 
 
DATA(ld_output_sel_screen_when_dialog) = ' '.
 
 
DATA(ld_output_sel_screen_when_batch) = ' '.
 
 


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!