SAP ARCHIVOBJECT_DISPLAY_PATH Function Module for









ARCHIVOBJECT_DISPLAY_PATH is a standard archivobject display path 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 path FM, simply by entering the name ARCHIVOBJECT_DISPLAY_PATH 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_PATH 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_PATH'"
  EXPORTING
*  ARCHIV_ID = ' ' "Archive ID
*  ARCHIV_DOC_ID = ' ' "Identifier of document to be displayed
*  APPLICATION = ' ' "
*  COUNT = ' ' "
*  PATH255 = ' ' "
   DOCUMENT_TYPE =  "
*  FILES_DOCUMENT = ' ' "
*  LANGUAGE = ' ' "
*  PATH_DOCUMENT = ' ' "
*  PATH_NOTE = ' ' "
*  SIGN = ' ' "
*  WINDOW_ID = ' ' "Unique window ID
*  WINDOW_TITLE = ' ' "Window title

 IMPORTING
   RETURNCODE =  "

EXCEPTIONS
   ERROR_ARCHIV = 1    ERROR_COMMUNICATIONTABLE = 2    ERROR_KERNEL = 3    ERROR_VERSION = 4    EXECUTE_FAILED = 5
.



IMPORTING Parameters details for ARCHIVOBJECT_DISPLAY_PATH

ARCHIV_ID - Archive ID

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

ARCHIV_DOC_ID - Identifier of document to be displayed

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

APPLICATION -

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

COUNT -

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

PATH255 -

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

DOCUMENT_TYPE -

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

FILES_DOCUMENT -

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

LANGUAGE -

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

PATH_DOCUMENT -

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

PATH_NOTE -

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

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)

WINDOW_TITLE - Window title

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

EXPORTING Parameters details for ARCHIVOBJECT_DISPLAY_PATH

RETURNCODE -

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

EXCEPTIONS details

ERROR_ARCHIV -

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

ERROR_COMMUNICATIONTABLE -

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

ERROR_KERNEL -

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

ERROR_VERSION -

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

EXECUTE_FAILED -

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

Copy and paste ABAP code example for ARCHIVOBJECT_DISPLAY_PATH 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_archiv_id  TYPE TOAAR-ARCHIV_ID, "   SPACE
lv_returncode  TYPE TOAAR, "   
lv_error_archiv  TYPE TOAAR, "   
lv_archiv_doc_id  TYPE TOAV0-ARC_DOC_ID, "   SPACE
lv_application  TYPE TOAIN-APPLICATIO, "   SPACE
lv_count  TYPE TOAIN, "   SPACE
lv_path255  TYPE CHAR255, "   SPACE
lv_document_type  TYPE SAPB-SAPDOKTYP, "   
lv_error_communicationtable  TYPE SAPB, "   
lv_error_kernel  TYPE SAPB, "   
lv_files_document  TYPE SAPB-SAPFILES, "   SPACE
lv_language  TYPE SAPB, "   SPACE
lv_error_version  TYPE SAPB, "   
lv_path_document  TYPE SAPB-SAPPFAD, "   SPACE
lv_execute_failed  TYPE SAPB, "   
lv_path_note  TYPE SAPB-SAPPATHFUL, "   SPACE
lv_sign  TYPE SAPB-SAPBZZ, "   SPACE
lv_window_id  TYPE SAPB-SAPWINID, "   SPACE
lv_window_title  TYPE SAPB-SAPWINTITL. "   SPACE

  CALL FUNCTION 'ARCHIVOBJECT_DISPLAY_PATH'  "
    EXPORTING
         ARCHIV_ID = lv_archiv_id
         ARCHIV_DOC_ID = lv_archiv_doc_id
         APPLICATION = lv_application
         COUNT = lv_count
         PATH255 = lv_path255
         DOCUMENT_TYPE = lv_document_type
         FILES_DOCUMENT = lv_files_document
         LANGUAGE = lv_language
         PATH_DOCUMENT = lv_path_document
         PATH_NOTE = lv_path_note
         SIGN = lv_sign
         WINDOW_ID = lv_window_id
         WINDOW_TITLE = lv_window_title
    IMPORTING
         RETURNCODE = lv_returncode
    EXCEPTIONS
        ERROR_ARCHIV = 1
        ERROR_COMMUNICATIONTABLE = 2
        ERROR_KERNEL = 3
        ERROR_VERSION = 4
        EXECUTE_FAILED = 5
. " ARCHIVOBJECT_DISPLAY_PATH




ABAP code using 7.40 inline data declarations to call FM ARCHIVOBJECT_DISPLAY_PATH

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_ID FROM TOAAR INTO @DATA(ld_archiv_id).
DATA(ld_archiv_id) = ' '.
 
 
 
"SELECT single ARC_DOC_ID FROM TOAV0 INTO @DATA(ld_archiv_doc_id).
DATA(ld_archiv_doc_id) = ' '.
 
"SELECT single APPLICATIO FROM TOAIN INTO @DATA(ld_application).
DATA(ld_application) = ' '.
 
DATA(ld_count) = ' '.
 
DATA(ld_path255) = ' '.
 
"SELECT single SAPDOKTYP FROM SAPB INTO @DATA(ld_document_type).
 
 
 
"SELECT single SAPFILES FROM SAPB INTO @DATA(ld_files_document).
DATA(ld_files_document) = ' '.
 
DATA(ld_language) = ' '.
 
 
"SELECT single SAPPFAD FROM SAPB INTO @DATA(ld_path_document).
DATA(ld_path_document) = ' '.
 
 
"SELECT single SAPPATHFUL FROM SAPB INTO @DATA(ld_path_note).
DATA(ld_path_note) = ' '.
 
"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) = ' '.
 
"SELECT single SAPWINTITL FROM SAPB INTO @DATA(ld_window_title).
DATA(ld_window_title) = ' '.
 


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!