SAP UJB_API_GET_RGN_LIST Function Module for BPC: Get step region list in a BPF instance









UJB_API_GET_RGN_LIST is a standard ujb api get rgn list SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for BPC: Get step region list in a BPF instance 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 ujb api get rgn list FM, simply by entering the name UJB_API_GET_RGN_LIST into the relevant SAP transaction such as SE37 or SE38.

Function Group: UJB1
Program Name: SAPLUJB1
Main Program: SAPLUJB1
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function UJB_API_GET_RGN_LIST 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 'UJB_API_GET_RGN_LIST'"BPC: Get step region list in a BPF instance
EXPORTING
I_APPSET_ID = "SAP BusinessObjects - AppSet ID
IS_USER = "BPC: User Login Info
I_INSTANCE_ID = "BPC: ID used in BPF
* I_STEP_RGN_STATUS = "BPC: Status of step region

IMPORTING
E_SUCCESS = "BPC: Generic indicator
ET_MESSAGE_LINES = "BPC: Messages
ET_AVL_STEP_RGN = "BPC: Table Type of UJB_S_API_RPT7_RGN
.



IMPORTING Parameters details for UJB_API_GET_RGN_LIST

I_APPSET_ID - SAP BusinessObjects - AppSet ID

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

IS_USER - BPC: User Login Info

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

I_INSTANCE_ID - BPC: ID used in BPF

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

I_STEP_RGN_STATUS - BPC: Status of step region

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

EXPORTING Parameters details for UJB_API_GET_RGN_LIST

E_SUCCESS - BPC: Generic indicator

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

ET_MESSAGE_LINES - BPC: Messages

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

ET_AVL_STEP_RGN - BPC: Table Type of UJB_S_API_RPT7_RGN

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

Copy and paste ABAP code example for UJB_API_GET_RGN_LIST 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_e_success  TYPE UJ_FLG, "   
lv_i_appset_id  TYPE UJ_APPSET_ID, "   
lv_is_user  TYPE UJ0_S_USER, "   
lv_et_message_lines  TYPE UJ0_T_MESSAGE, "   
lv_i_instance_id  TYPE UJB_ID, "   
lv_et_avl_step_rgn  TYPE UJB_T_API_RPT7_RGN, "   
lv_i_step_rgn_status  TYPE UJB_STEPREGION_STATUS. "   

  CALL FUNCTION 'UJB_API_GET_RGN_LIST'  "BPC: Get step region list in a BPF instance
    EXPORTING
         I_APPSET_ID = lv_i_appset_id
         IS_USER = lv_is_user
         I_INSTANCE_ID = lv_i_instance_id
         I_STEP_RGN_STATUS = lv_i_step_rgn_status
    IMPORTING
         E_SUCCESS = lv_e_success
         ET_MESSAGE_LINES = lv_et_message_lines
         ET_AVL_STEP_RGN = lv_et_avl_step_rgn
. " UJB_API_GET_RGN_LIST




ABAP code using 7.40 inline data declarations to call FM UJB_API_GET_RGN_LIST

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



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!