SAP ENQUEUE_ESARCHIVE Function Module for Request lock for object ESARCHIVE

Search SAP Function Modules

ENQUEUE_ESARCHIVE is a standard enqueue esarchive SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Request lock for object ESARCHIVE 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 enqueue esarchive FM, simply by entering the name ENQUEUE_ESARCHIVE into the relevant SAP transaction such as SE37 or SE38.

Function Group: /1BCDWBEN/SEN0004
Program Name: /1BCDWBEN/SAPLSEN0004
Main Program:
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:

Function ENQUEUE_ESARCHIVE 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 'ENQUEUE_ESARCHIVE'"Request lock for object ESARCHIVE
  EXPORTING
*  MODE_ARCH_OBJ = 'E' "Lock mode for table ARCH_OBJ
*  OBJECT =  "01th enqueue argument
*  X_OBJECT = ' ' "Fill argument 01 with initial value?
*  _SCOPE = '2' "
*  _WAIT = ' ' "
*  _COLLECT = ' ' "Initially only collect lock

EXCEPTIONS
   FOREIGN_LOCK = 1    SYSTEM_FAILURE = 2 

.

IMPORTING Parameters details for ENQUEUE_ESARCHIVE

MODE_ARCH_OBJ - Lock mode for table ARCH_OBJ

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

OBJECT - 01th enqueue argument

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

X_OBJECT - Fill argument 01 with initial value?

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

_SCOPE -

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

_WAIT -

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

_COLLECT - Initially only collect lock

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

EXCEPTIONS details

FOREIGN_LOCK - Object already locked

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

SYSTEM_FAILURE - Internal error from enqueue server

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

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

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