SAP CDOCS_CONT_ARCHIVE_OBJECT Function Module for Archivierungsklasse CGPL - Projekt archivieren









CDOCS_CONT_ARCHIVE_OBJECT is a standard cdocs cont archive object SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Archivierungsklasse CGPL - Projekt archivieren 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 cdocs cont archive object FM, simply by entering the name CDOCS_CONT_ARCHIVE_OBJECT into the relevant SAP transaction such as SE37 or SE38.

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



Function CDOCS_CONT_ARCHIVE_OBJECT 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 'CDOCS_CONT_ARCHIVE_OBJECT'"Archivierungsklasse CGPL - Projekt archivieren
EXPORTING
ARCHIVE_HANDLE = "Interne Tabellen, aktueller Zeilenindex
FILE_ARCH_IOS = "CDOCS: Liste von zu archivierenden IOs
* DELETE_OBJECT_FLAG = 'X' "Objekte nach Archivierung löschen

EXCEPTIONS
WRONG_ACCESS_TO_ARCHIVE = 1 FAILED = 2
.



IMPORTING Parameters details for CDOCS_CONT_ARCHIVE_OBJECT

ARCHIVE_HANDLE - Interne Tabellen, aktueller Zeilenindex

Data type: SYTABIX
Optional: No
Call by Reference: Yes

FILE_ARCH_IOS - CDOCS: Liste von zu archivierenden IOs

Data type: CFX_TT_CDOCS_ARCH_IO
Optional: No
Call by Reference: Yes

DELETE_OBJECT_FLAG - Objekte nach Archivierung löschen

Data type: FLAG
Default: 'X'
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

WRONG_ACCESS_TO_ARCHIVE - Falscher Zugriff auf Archiv

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

FAILED - Anwendung unterstützt Archivierung nicht

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

Copy and paste ABAP code example for CDOCS_CONT_ARCHIVE_OBJECT 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_handle  TYPE SYTABIX, "   
lv_wrong_access_to_archive  TYPE SYTABIX, "   
lv_failed  TYPE SYTABIX, "   
lv_file_arch_ios  TYPE CFX_TT_CDOCS_ARCH_IO, "   
lv_delete_object_flag  TYPE FLAG. "   'X'

  CALL FUNCTION 'CDOCS_CONT_ARCHIVE_OBJECT'  "Archivierungsklasse CGPL - Projekt archivieren
    EXPORTING
         ARCHIVE_HANDLE = lv_archive_handle
         FILE_ARCH_IOS = lv_file_arch_ios
         DELETE_OBJECT_FLAG = lv_delete_object_flag
    EXCEPTIONS
        WRONG_ACCESS_TO_ARCHIVE = 1
        FAILED = 2
. " CDOCS_CONT_ARCHIVE_OBJECT




ABAP code using 7.40 inline data declarations to call FM CDOCS_CONT_ARCHIVE_OBJECT

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.

 
 
 
 
DATA(ld_delete_object_flag) = 'X'.
 


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!