SAP LOIO_ARCHIVE_OBJECT Function Module for Mark Logical Documents for Archiving
LOIO_ARCHIVE_OBJECT is a standard loio 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 Mark Logical Documents for Archiving 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 loio archive object FM, simply by entering the name LOIO_ARCHIVE_OBJECT into the relevant SAP transaction such as SE37 or SE38.
Function Group: SDC_ARCH_LOIO
Program Name: SAPLSDC_ARCH_LOIO
Main Program: SAPLSDC_ARCH_LOIO
Appliation area:
Release date: 02-Nov-2001
Mode(Normal, Remote etc): Normal Function Module
Update:
Function LOIO_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 'LOIO_ARCHIVE_OBJECT'"Mark Logical Documents for Archiving.
EXPORTING
ARCHIVE_HANDLE = "Internal Tables, Current Row Index
CLASS = "Document Class
OBJID = "Logical Document
* CLIENT = SY-MANDT "R/3 System, Client Number from Logon
* OBJECT_DELETE_FLAG = ' ' "Delete Archived Documents
* ARCHIVE_REIOS = 'X' "Relationships for Archiving
* ARCHIVE_PHIOS = 'X' "Physical Documents for Archiving
* KEEP_CONTENT = ' ' "
EXCEPTIONS
WRONG_ACCESS_TO_ARCHIVE = 1 CLASS_NOT_INITIALIZED = 2
IMPORTING Parameters details for LOIO_ARCHIVE_OBJECT
ARCHIVE_HANDLE - Internal Tables, Current Row Index
Data type: SY-TABIXOptional: No
Call by Reference: No ( called with pass by value option)
CLASS - Document Class
Data type: SDOKLOCL-LO_CLASSOptional: No
Call by Reference: No ( called with pass by value option)
OBJID - Logical Document
Data type: SDOKLOIO-LOIO_IDOptional: No
Call by Reference: No ( called with pass by value option)
CLIENT - R/3 System, Client Number from Logon
Data type: SY-MANDTDefault: SY-MANDT
Optional: Yes
Call by Reference: No ( called with pass by value option)
OBJECT_DELETE_FLAG - Delete Archived Documents
Data type: ANYDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
ARCHIVE_REIOS - Relationships for Archiving
Data type: SY-DATARDefault: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)
ARCHIVE_PHIOS - Physical Documents for Archiving
Data type: SY-DATARDefault: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)
KEEP_CONTENT -
Data type: SY-DATARDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
EXCEPTIONS details
WRONG_ACCESS_TO_ARCHIVE - Error in Accessing Archive
Data type:Optional: No
Call by Reference: Yes
CLASS_NOT_INITIALIZED - Class Not Initialized
Data type:Optional: No
Call by Reference: Yes
Copy and paste ABAP code example for LOIO_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 SY-TABIX, " | |||
| lv_wrong_access_to_archive | TYPE SY, " | |||
| lv_class | TYPE SDOKLOCL-LO_CLASS, " | |||
| lv_class_not_initialized | TYPE SDOKLOCL, " | |||
| lv_objid | TYPE SDOKLOIO-LOIO_ID, " | |||
| lv_client | TYPE SY-MANDT, " SY-MANDT | |||
| lv_object_delete_flag | TYPE ANY, " ' ' | |||
| lv_archive_reios | TYPE SY-DATAR, " 'X' | |||
| lv_archive_phios | TYPE SY-DATAR, " 'X' | |||
| lv_keep_content | TYPE SY-DATAR. " ' ' |
| CALL FUNCTION 'LOIO_ARCHIVE_OBJECT' "Mark Logical Documents for Archiving |
| EXPORTING | ||
| ARCHIVE_HANDLE | = lv_archive_handle | |
| CLASS | = lv_class | |
| OBJID | = lv_objid | |
| CLIENT | = lv_client | |
| OBJECT_DELETE_FLAG | = lv_object_delete_flag | |
| ARCHIVE_REIOS | = lv_archive_reios | |
| ARCHIVE_PHIOS | = lv_archive_phios | |
| KEEP_CONTENT | = lv_keep_content | |
| EXCEPTIONS | ||
| WRONG_ACCESS_TO_ARCHIVE = 1 | ||
| CLASS_NOT_INITIALIZED = 2 | ||
| . " LOIO_ARCHIVE_OBJECT | ||
ABAP code using 7.40 inline data declarations to call FM LOIO_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.| "SELECT single TABIX FROM SY INTO @DATA(ld_archive_handle). | ||||
| "SELECT single LO_CLASS FROM SDOKLOCL INTO @DATA(ld_class). | ||||
| "SELECT single LOIO_ID FROM SDOKLOIO INTO @DATA(ld_objid). | ||||
| "SELECT single MANDT FROM SY INTO @DATA(ld_client). | ||||
| DATA(ld_client) | = SY-MANDT. | |||
| DATA(ld_object_delete_flag) | = ' '. | |||
| "SELECT single DATAR FROM SY INTO @DATA(ld_archive_reios). | ||||
| DATA(ld_archive_reios) | = 'X'. | |||
| "SELECT single DATAR FROM SY INTO @DATA(ld_archive_phios). | ||||
| DATA(ld_archive_phios) | = 'X'. | |||
| "SELECT single DATAR FROM SY INTO @DATA(ld_keep_content). | ||||
| DATA(ld_keep_content) | = ' '. | |||
Search for further information about these or an SAP related objects