SAP ARCHIVOBJECT_DISPLAY Function Module for









ARCHIVOBJECT_DISPLAY is a standard archivobject display SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 archivobject display FM, simply by entering the name ARCHIVOBJECT_DISPLAY into the relevant SAP transaction such as SE37 or SE38.

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



Function ARCHIVOBJECT_DISPLAY 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 'ARCHIVOBJECT_DISPLAY'"
  EXPORTING
*  ARCHIV_DOC_ID =  "Identifier of document to be displayed
*  WINDOW_TITLE = ' ' "Window title
*  DOC_TYPE = ' ' "Document type
*  POSITIONINALFFILE = ' ' "Item
*  NOGET = ' ' "
*  PATHOFFILE = ' ' "
*  EOF = ' ' "
*  DALENGTH = ' ' "
*  PFSTATUS = ' ' "
*  REPORT = ' ' "
*  MULTIPLE = ' ' "
*  ARCHIV_DOC_INDEX = ' ' "(no longer used)
*  ARCHIV_ID =  "Archive ID
*  OBJECTTYPE = ' ' "
*  OBJECT_ID = ' ' "
*  AR_OBJECT = ' ' "
*  LANGUAGE = ' ' "Logon language
*  SIGN = ' ' "Reference sign
*  WINDOW_ID = ' ' "Unique window ID

 IMPORTING
   RETURNCODE =  "Confirmation

TABLES
*  DISPDOCS =  "Structure for Displaying Documents

EXCEPTIONS
   ERROR_ARCHIV = 1    ERROR_COMMUNICATIONTABLE = 2    ERROR_KERNEL = 3
.



IMPORTING Parameters details for ARCHIVOBJECT_DISPLAY

ARCHIV_DOC_ID - Identifier of document to be displayed

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

WINDOW_TITLE - Window title

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

DOC_TYPE - Document type

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

POSITIONINALFFILE - Item

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

NOGET -

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

PATHOFFILE -

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

EOF -

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

DALENGTH -

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

PFSTATUS -

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

REPORT -

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

MULTIPLE -

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

ARCHIV_DOC_INDEX - (no longer used)

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

ARCHIV_ID - Archive ID

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

OBJECTTYPE -

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

OBJECT_ID -

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

AR_OBJECT -

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

LANGUAGE - Logon language

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

SIGN - Reference sign

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

WINDOW_ID - Unique window ID

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

EXPORTING Parameters details for ARCHIVOBJECT_DISPLAY

RETURNCODE - Confirmation

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

TABLES Parameters details for ARCHIVOBJECT_DISPLAY

DISPDOCS - Structure for Displaying Documents

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

EXCEPTIONS details

ERROR_ARCHIV - Archive system error

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

ERROR_COMMUNICATIONTABLE - Inconsistencies in archive table

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

ERROR_KERNEL - SAP kernel error

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

Copy and paste ABAP code example for ARCHIVOBJECT_DISPLAY 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:
lt_dispdocs  TYPE STANDARD TABLE OF TOADI, "   
lv_returncode  TYPE TOADI, "   
lv_error_archiv  TYPE TOADI, "   
lv_archiv_doc_id  TYPE SAPB-SAPADOKID, "   
lv_window_title  TYPE SAPB-SAPWINTITL, "   SPACE
lv_doc_type  TYPE TOAOM-DOC_TYPE, "   SPACE
lv_positioninalffile  TYPE TOAOM, "   SPACE
lv_noget  TYPE TOAOM, "   SPACE
lv_pathoffile  TYPE TOAOM, "   SPACE
lv_eof  TYPE TOAOM, "   SPACE
lv_dalength  TYPE TOADL-DATALENGTH, "   SPACE
lv_pfstatus  TYPE SY-PFKEY, "   SPACE
lv_report  TYPE RS38M-PROGRAMM, "   SPACE
lv_multiple  TYPE RS38M, "   SPACE
lv_archiv_doc_index  TYPE SAPB-SAPADOKID, "   SPACE
lv_error_communicationtable  TYPE SAPB, "   
lv_archiv_id  TYPE TOAAR-ARCHIV_ID, "   
lv_error_kernel  TYPE TOAAR, "   
lv_objecttype  TYPE TOAV0-SAP_OBJECT, "   SPACE
lv_object_id  TYPE TOAV0-OBJECT_ID, "   SPACE
lv_ar_object  TYPE TOAV0-AR_OBJECT, "   SPACE
lv_language  TYPE TOAV0, "   SPACE
lv_sign  TYPE SAPB-SAPBZZ, "   SPACE
lv_window_id  TYPE SAPB-SAPWINID. "   SPACE

  CALL FUNCTION 'ARCHIVOBJECT_DISPLAY'  "
    EXPORTING
         ARCHIV_DOC_ID = lv_archiv_doc_id
         WINDOW_TITLE = lv_window_title
         DOC_TYPE = lv_doc_type
         POSITIONINALFFILE = lv_positioninalffile
         NOGET = lv_noget
         PATHOFFILE = lv_pathoffile
         EOF = lv_eof
         DALENGTH = lv_dalength
         PFSTATUS = lv_pfstatus
         REPORT = lv_report
         MULTIPLE = lv_multiple
         ARCHIV_DOC_INDEX = lv_archiv_doc_index
         ARCHIV_ID = lv_archiv_id
         OBJECTTYPE = lv_objecttype
         OBJECT_ID = lv_object_id
         AR_OBJECT = lv_ar_object
         LANGUAGE = lv_language
         SIGN = lv_sign
         WINDOW_ID = lv_window_id
    IMPORTING
         RETURNCODE = lv_returncode
    TABLES
         DISPDOCS = lt_dispdocs
    EXCEPTIONS
        ERROR_ARCHIV = 1
        ERROR_COMMUNICATIONTABLE = 2
        ERROR_KERNEL = 3
. " ARCHIVOBJECT_DISPLAY




ABAP code using 7.40 inline data declarations to call FM ARCHIVOBJECT_DISPLAY

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 SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_id).
 
"SELECT single SAPWINTITL FROM SAPB INTO @DATA(ld_window_title).
DATA(ld_window_title) = ' '.
 
"SELECT single DOC_TYPE FROM TOAOM INTO @DATA(ld_doc_type).
DATA(ld_doc_type) = ' '.
 
DATA(ld_positioninalffile) = ' '.
 
DATA(ld_noget) = ' '.
 
DATA(ld_pathoffile) = ' '.
 
DATA(ld_eof) = ' '.
 
"SELECT single DATALENGTH FROM TOADL INTO @DATA(ld_dalength).
DATA(ld_dalength) = ' '.
 
"SELECT single PFKEY FROM SY INTO @DATA(ld_pfstatus).
DATA(ld_pfstatus) = ' '.
 
"SELECT single PROGRAMM FROM RS38M INTO @DATA(ld_report).
DATA(ld_report) = ' '.
 
DATA(ld_multiple) = ' '.
 
"SELECT single SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_index).
DATA(ld_archiv_doc_index) = ' '.
 
 
"SELECT single ARCHIV_ID FROM TOAAR INTO @DATA(ld_archiv_id).
 
 
"SELECT single SAP_OBJECT FROM TOAV0 INTO @DATA(ld_objecttype).
DATA(ld_objecttype) = ' '.
 
"SELECT single OBJECT_ID FROM TOAV0 INTO @DATA(ld_object_id).
DATA(ld_object_id) = ' '.
 
"SELECT single AR_OBJECT FROM TOAV0 INTO @DATA(ld_ar_object).
DATA(ld_ar_object) = ' '.
 
DATA(ld_language) = ' '.
 
"SELECT single SAPBZZ FROM SAPB INTO @DATA(ld_sign).
DATA(ld_sign) = ' '.
 
"SELECT single SAPWINID FROM SAPB INTO @DATA(ld_window_id).
DATA(ld_window_id) = ' '.
 


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!