SAP UPSCP_ENQUEUE Function Module for PUB/INS: Set Lock









UPSCP_ENQUEUE is a standard upscp enqueue SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for PUB/INS: Set Lock 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 upscp enqueue FM, simply by entering the name UPSCP_ENQUEUE into the relevant SAP transaction such as SE37 or SE38.

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



Function UPSCP_ENQUEUE 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 'UPSCP_ENQUEUE'"PUB/INS: Set Lock
EXPORTING
IM_INSTID = "ALE Distribution Packet: ID for Instantiation
* IM_UPSNUM = "ALE Distribution Packet : Number
* FLG_USE_EXIST_UPSNUM = KUPS_TRUE "
* FLG_EXIST = KUPS_TRUE "

EXCEPTIONS
FOREIGN_LOCK = 1 SYSTEM_FAILURE = 2 FAILING_INSTANCE = 3
.



IMPORTING Parameters details for UPSCP_ENQUEUE

IM_INSTID - ALE Distribution Packet: ID for Instantiation

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

IM_UPSNUM - ALE Distribution Packet : Number

Data type: UPSHDR-UPSNUM
Optional: Yes
Call by Reference: Yes

FLG_USE_EXIST_UPSNUM -

Data type: XFELD
Default: KUPS_TRUE
Optional: Yes
Call by Reference: Yes

FLG_EXIST -

Data type: XFELD
Default: KUPS_TRUE
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

FOREIGN_LOCK - Object Already Locked

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

SYSTEM_FAILURE - Error in lock management

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

FAILING_INSTANCE - Object Instance Not Available

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

Copy and paste ABAP code example for UPSCP_ENQUEUE 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_im_instid  TYPE UPS_INSTID, "   
lv_foreign_lock  TYPE UPS_INSTID, "   
lv_im_upsnum  TYPE UPSHDR-UPSNUM, "   
lv_system_failure  TYPE UPSHDR, "   
lv_failing_instance  TYPE UPSHDR, "   
lv_flg_use_exist_upsnum  TYPE XFELD, "   KUPS_TRUE
lv_flg_exist  TYPE XFELD. "   KUPS_TRUE

  CALL FUNCTION 'UPSCP_ENQUEUE'  "PUB/INS: Set Lock
    EXPORTING
         IM_INSTID = lv_im_instid
         IM_UPSNUM = lv_im_upsnum
         FLG_USE_EXIST_UPSNUM = lv_flg_use_exist_upsnum
         FLG_EXIST = lv_flg_exist
    EXCEPTIONS
        FOREIGN_LOCK = 1
        SYSTEM_FAILURE = 2
        FAILING_INSTANCE = 3
. " UPSCP_ENQUEUE




ABAP code using 7.40 inline data declarations to call FM UPSCP_ENQUEUE

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 UPSNUM FROM UPSHDR INTO @DATA(ld_im_upsnum).
 
 
 
DATA(ld_flg_use_exist_upsnum) = KUPS_TRUE.
 
DATA(ld_flg_exist) = KUPS_TRUE.
 


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!