SAP Function Modules

comments icon Comments

HR_ENQUEUE_OBJECT SAP Function module - Lock HR Objects







HR_ENQUEUE_OBJECT is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name HR_ENQUEUE_OBJECT into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: HRBAS00ENQDEQ
Released Date: 17.09.1998
Processing type: Normal fucntion module
Normal function module settings


Pattern for FM HR_ENQUEUE_OBJECT - HR ENQUEUE OBJECT 





CALL FUNCTION 'HR_ENQUEUE_OBJECT' "Lock HR Objects
  EXPORTING
    plvar =                     " ppenq-plvar   Plan Version
    otype =                     " ppenq-otype   Object Type
    objid =                     " ppenq-objid   Object Number
*   enqueue_once = SPACE        " c             Do Not Lock Objects More Than Once
*   enq_scope = '2'             " ddenqscope    Control Lock Behavior When Calling the Update Task
*   enq_wait = SPACE            " ddenqwait     Flag Indicating Whether Lock Attempt Is to Be Repeated
*   enq_collect = ' '           " ddenqcoll     Flag whether locks should only be collected first
  IMPORTING
    lock_user =                 " sy-uname      User Locking the Object
  EXCEPTIONS
    ENQUEUE_FAILED = 1          "               Object Already Locked
    OBJID_IS_INITIAL = 2        "               Object ID Empty
    ILLEGAL_OTYPE = 3           "               Object Type not Permitted
    INTERNAL_ERROR = 4          "               System Error
    .  "  HR_ENQUEUE_OBJECT

ABAP code example for Function Module HR_ENQUEUE_OBJECT





The ABAP code below is a full code listing to execute function module HR_ENQUEUE_OBJECT including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_lock_user    TYPE SY-UNAME
.





DATA(ld_plvar) = some text here


DATA(ld_otype) = some text here


DATA(ld_objid) = Check type of data required

DATA(ld_enqueue_once) = 'Check type of data required'.

DATA(ld_enq_scope) = 'Check type of data required'.

DATA(ld_enq_wait) = 'Check type of data required'.

DATA(ld_enq_collect) = 'Check type of data required'.
.

CALL FUNCTION 'HR_ENQUEUE_OBJECT'
  EXPORTING
    plvar =                      ld_plvar
    otype =                      ld_otype
    objid =                      ld_objid
*   enqueue_once =               ld_enqueue_once
*   enq_scope =                  ld_enq_scope
*   enq_wait =                   ld_enq_wait
*   enq_collect =                ld_enq_collect
  IMPORTING
    lock_user =                  ld_lock_user
  EXCEPTIONS
    ENQUEUE_FAILED =             1
    OBJID_IS_INITIAL =           2
    ILLEGAL_OTYPE =              3
    INTERNAL_ERROR =             4
    .  "  HR_ENQUEUE_OBJECT

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 4. "Exception
  "Add code for exception here
ENDIF.







ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:


ld_lock_user  TYPE SY-UNAME ,
ld_plvar  TYPE PPENQ-PLVAR ,
ld_otype  TYPE PPENQ-OTYPE ,
ld_objid  TYPE PPENQ-OBJID ,
ld_enqueue_once  TYPE C ,
ld_enq_scope  TYPE DDENQSCOPE ,
ld_enq_wait  TYPE DDENQWAIT ,
ld_enq_collect  TYPE DDENQCOLL .





ld_plvar = some text here

ld_otype = some text here

ld_objid = Check type of data required
ld_enqueue_once = 'Check type of data required'.
ld_enq_scope = 'Check type of data required'.
ld_enq_wait = 'Check type of data required'.
ld_enq_collect = 'Check type of data required'.

SAP Documentation for FM HR_ENQUEUE_OBJECT


This module represents lock management in HR. You can use it to lock complete objects. ...See here for full SAP fm documentation

Contribute (Add Comments)

Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name HR_ENQUEUE_OBJECT or its description.


   
 

HR_ENQUEUE_OBJECT - Lock HR Objects
HR_ENABLE_INIT_BUFFER - 
HR_EMPLOYEE_SEARCH - 
HR_EMPLOYEE_RECOGNITION - 
HR_EMPLOYEE_LIST - 
HR_EMPLOYEE_ENQUEUE -