SAP ARCHIVE_ADMIN_POPUP_DOCUMENTS Function Module for Dialog Box for Selecting Existing Arcive Files









ARCHIVE_ADMIN_POPUP_DOCUMENTS is a standard archive admin popup documents SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Dialog Box for Selecting Existing Arcive Files 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 admin popup documents FM, simply by entering the name ARCHIVE_ADMIN_POPUP_DOCUMENTS into the relevant SAP transaction such as SE37 or SE38.

Function Group: AADM
Program Name: SAPLAADM
Main Program: SAPLAADM
Appliation area: S
Release date: 03-Jan-1995
Mode(Normal, Remote etc): Normal Function Module
Update:



Function ARCHIVE_ADMIN_POPUP_DOCUMENTS 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_ADMIN_POPUP_DOCUMENTS'"Dialog Box for Selecting Existing Arcive Files
EXPORTING
OBJECT = "Archiving Object
* SHOW_DELETED_RUN = ' ' "Show Hidden Sessions
* SHOW_FILES = 'X' "Allow Files to Be Displayed
* DIALOG_TYPE = 'READ' "File Selection Type
* RADIO_BUTTONS = ' ' "Select One Archiving Session Only
* RADIO_FILES = ' ' "Select Only One Archive File
* OLD_SID = "Internal Parameter for RW
* OLD_CLIENT = "Internal Parameter for RW
* USE_ORIGIN_FILTER = ' ' "RW: Filter by Original (DIALOG_TYPE = 'READ' and SHOW_FILES = 'X' only)

TABLES
* SELECTED_FILES = "Table with the Selected Files
* EXTERNAL_FILES = "Tables Transferred with Logical File Names
* SELECTED_SESSIONS = "Table with the Selected Archiving Sessions
* EXTERNAL_SESSIONS = "Table with the Archiving Sessions to Which the Selection Is to Be Restricted

EXCEPTIONS
OBJECT_NOT_FOUND = 1 CANCELLED_BY_USER = 2 NO_FILES_SELECTED = 3 UNKNOWN_DIALOG_TYPE = 4
.



IMPORTING Parameters details for ARCHIVE_ADMIN_POPUP_DOCUMENTS

OBJECT - Archiving Object

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

SHOW_DELETED_RUN - Show Hidden Sessions

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

SHOW_FILES - Allow Files to Be Displayed

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

DIALOG_TYPE - File Selection Type

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

RADIO_BUTTONS - Select One Archiving Session Only

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

RADIO_FILES - Select Only One Archive File

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

OLD_SID - Internal Parameter for RW

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

OLD_CLIENT - Internal Parameter for RW

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

USE_ORIGIN_FILTER - RW: Filter by Original (DIALOG_TYPE = 'READ' and SHOW_FILES = 'X' only)

Data type: BOOLE_D
Default: SPACE
Optional: Yes
Call by Reference: Yes

TABLES Parameters details for ARCHIVE_ADMIN_POPUP_DOCUMENTS

SELECTED_FILES - Table with the Selected Files

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

EXTERNAL_FILES - Tables Transferred with Logical File Names

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

SELECTED_SESSIONS - Table with the Selected Archiving Sessions

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

EXTERNAL_SESSIONS - Table with the Archiving Sessions to Which the Selection Is to Be Restricted

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

EXCEPTIONS details

OBJECT_NOT_FOUND - Unknown Object

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

CANCELLED_BY_USER - User Has Terminated Dialog

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

NO_FILES_SELECTED - User Did not Choose any Files

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

UNKNOWN_DIALOG_TYPE - Unknown Contents in Parameter DIALOG_TYPE

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

Copy and paste ABAP code example for ARCHIVE_ADMIN_POPUP_DOCUMENTS 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_object  TYPE ARCH_OBJ-OBJECT, "   
lt_selected_files  TYPE STANDARD TABLE OF ADMI_FILES, "   
lv_object_not_found  TYPE ADMI_FILES, "   
lt_external_files  TYPE STANDARD TABLE OF ARCHIV_KEY, "   
lv_show_deleted_run  TYPE ARCHIV_KEY, "   SPACE
lv_cancelled_by_user  TYPE ARCHIV_KEY, "   
lv_show_files  TYPE ARCHIV_KEY, "   'X'
lv_no_files_selected  TYPE ARCHIV_KEY, "   
lt_selected_sessions  TYPE STANDARD TABLE OF ARCH_SESSN, "   
lv_dialog_type  TYPE ARCH_SESSN, "   'READ'
lt_external_sessions  TYPE STANDARD TABLE OF ARCH_SESSN, "   
lv_unknown_dialog_type  TYPE ARCH_SESSN, "   
lv_radio_buttons  TYPE ARCH_SESSN, "   SPACE
lv_radio_files  TYPE ARCH_SESSN, "   SPACE
lv_old_sid  TYPE SYSYSID, "   
lv_old_client  TYPE SYMANDT, "   
lv_use_origin_filter  TYPE BOOLE_D. "   SPACE

  CALL FUNCTION 'ARCHIVE_ADMIN_POPUP_DOCUMENTS'  "Dialog Box for Selecting Existing Arcive Files
    EXPORTING
         OBJECT = lv_object
         SHOW_DELETED_RUN = lv_show_deleted_run
         SHOW_FILES = lv_show_files
         DIALOG_TYPE = lv_dialog_type
         RADIO_BUTTONS = lv_radio_buttons
         RADIO_FILES = lv_radio_files
         OLD_SID = lv_old_sid
         OLD_CLIENT = lv_old_client
         USE_ORIGIN_FILTER = lv_use_origin_filter
    TABLES
         SELECTED_FILES = lt_selected_files
         EXTERNAL_FILES = lt_external_files
         SELECTED_SESSIONS = lt_selected_sessions
         EXTERNAL_SESSIONS = lt_external_sessions
    EXCEPTIONS
        OBJECT_NOT_FOUND = 1
        CANCELLED_BY_USER = 2
        NO_FILES_SELECTED = 3
        UNKNOWN_DIALOG_TYPE = 4
. " ARCHIVE_ADMIN_POPUP_DOCUMENTS




ABAP code using 7.40 inline data declarations to call FM ARCHIVE_ADMIN_POPUP_DOCUMENTS

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 OBJECT FROM ARCH_OBJ INTO @DATA(ld_object).
 
 
 
 
DATA(ld_show_deleted_run) = ' '.
 
 
DATA(ld_show_files) = 'X'.
 
 
 
DATA(ld_dialog_type) = 'READ'.
 
 
 
DATA(ld_radio_buttons) = ' '.
 
DATA(ld_radio_files) = ' '.
 
 
 
DATA(ld_use_origin_filter) = ' '.
 


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!