SAP ARCHIVE_OPEN_FOR_WRITE Function Module for Open Archive File for Writing

Search SAP Function Modules

ARCHIVE_OPEN_FOR_WRITE is a standard archive open for write SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Open Archive File for Writing 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 open for write FM, simply by entering the name ARCHIVE_OPEN_FOR_WRITE into the relevant SAP transaction such as SE37 or SE38.

Function Group: ARCH
Program Name: SAPLARCH
Main Program: SAPLARCH
Appliation area:
Release date: 10-Jan-1995
Mode(Normal, Remote etc): Normal Function Module
Update:

Function ARCHIVE_OPEN_FOR_WRITE 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_OPEN_FOR_WRITE'"Open Archive File for Writing
  EXPORTING
*  CALL_DELETE_JOB_IN_TEST_MODE = 'X' "Run Delete Program in Test Mode Only
*  CREATE_ARCHIVE_FILE = 'X' "Create or Do not Create Archive File
   OBJECT =  "Archiving Object Name
*  COMMENTS = ' ' "Comment Line For Archiving Session
*  DO_NOT_DELETE_DATA = ' ' "Do not Delete Archived Data
*  OUTPUT_SEL_SCREEN_WHEN_DIALOG = ' ' "If in Dialog Mode, Output Selection Screen
*  OUTPUT_SEL_SCREEN_WHEN_BATCH = ' ' "If in Background, Output Selection Screen
*  DESTROY = ABAP_FALSE "Indicator for Archiving Session for Data Destruction

 IMPORTING
   ARCHIVE_HANDLE =  "Pointer to Open File

EXCEPTIONS
   INTERNAL_ERROR = 1    OBJECT_NOT_FOUND = 2    OPEN_ERROR = 3    NOT_AUTHORIZED = 4    ARCHIVING_STANDARD_VIOLATION = 5 

.

IMPORTING Parameters details for ARCHIVE_OPEN_FOR_WRITE

CALL_DELETE_JOB_IN_TEST_MODE - Run Delete Program in Test Mode Only

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

CREATE_ARCHIVE_FILE - Create or Do not Create Archive File

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

OBJECT - Archiving Object Name

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

COMMENTS - Comment Line For Archiving Session

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

DO_NOT_DELETE_DATA - Do not Delete Archived Data

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

OUTPUT_SEL_SCREEN_WHEN_DIALOG - If in Dialog Mode, Output Selection Screen

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

OUTPUT_SEL_SCREEN_WHEN_BATCH - If in Background, Output Selection Screen

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

DESTROY - Indicator for Archiving Session for Data Destruction

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

EXPORTING Parameters details for ARCHIVE_OPEN_FOR_WRITE

ARCHIVE_HANDLE - Pointer to Open File

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

EXCEPTIONS details

INTERNAL_ERROR - Internal error

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

OBJECT_NOT_FOUND - Unknown Object

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

OPEN_ERROR - Could not open file

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

NOT_AUTHORIZED - No Authorization for ARCHIVE_OPEN_FOR_WRITE

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

ARCHIVING_STANDARD_VIOLATION - Violation of the Archiving Standard

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for ARCHIVE_OPEN_FOR_WRITE 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.

ABAP code using 7.40 inline data declarations to call FM ARCHIVE_OPEN_FOR_WRITE

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.

Search for further information about these or an SAP related objects