SAP CMS_UI_PAT_EVENT_GET_UIP Function Module for Event Handler for GET UI Parameters of the Controller









CMS_UI_PAT_EVENT_GET_UIP is a standard cms ui pat event get uip SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Event Handler for GET UI Parameters of the Controller 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 cms ui pat event get uip FM, simply by entering the name CMS_UI_PAT_EVENT_GET_UIP into the relevant SAP transaction such as SE37 or SE38.

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



Function CMS_UI_PAT_EVENT_GET_UIP 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 'CMS_UI_PAT_EVENT_GET_UIP'"Event Handler for GET UI Parameters of the Controller
  EXPORTING
*  I_ENTITY_TYPE =  "Entity Type
*  I_OBJ_ID =  "CMS Object Identifier
*  I_ADMIN_ORG =  "Administrative Organisational Unit
*  I_ACTIVITY =  "Controller: Activity

 IMPORTING
   E_OBJ_ID =  "CMS Object Identifier
   E_STR_PCN_PARAM =  "Process control key behaviour
   E_TAB_FLDVAL =  "Table of field values
   E_FSTAT_VAR =  "Object Screen (Field Status Variant)
   E_ACTVT =  "Activity ID
   E_TAB_AUTH_ACTVT =  "Activities
   E_TAB_RC =  "Return Code and corresponding Message
.



IMPORTING Parameters details for CMS_UI_PAT_EVENT_GET_UIP

I_ENTITY_TYPE - Entity Type

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

I_OBJ_ID - CMS Object Identifier

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

I_ADMIN_ORG - Administrative Organisational Unit

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

I_ACTIVITY - Controller: Activity

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

EXPORTING Parameters details for CMS_UI_PAT_EVENT_GET_UIP

E_OBJ_ID - CMS Object Identifier

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

E_STR_PCN_PARAM - Process control key behaviour

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

E_TAB_FLDVAL - Table of field values

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

E_FSTAT_VAR - Object Screen (Field Status Variant)

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

E_ACTVT - Activity ID

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

E_TAB_AUTH_ACTVT - Activities

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

E_TAB_RC - Return Code and corresponding Message

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

Copy and paste ABAP code example for CMS_UI_PAT_EVENT_GET_UIP 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_obj_id  TYPE CMS_DTE_OBJ_ID, "   
lv_i_entity_type  TYPE CMS_DTE_TYP, "   
lv_i_obj_id  TYPE CMS_DTE_OBJ_ID, "   
lv_e_str_pcn_param  TYPE CMS_STR_PCN_CKY_B, "   
lv_i_admin_org  TYPE CMS_DTE_ADMINORG, "   
lv_e_tab_fldval  TYPE CMS_TAB_FLDVAL, "   
lv_i_activity  TYPE CMS_DTE_IND_CTRL_ACTIVITY, "   
lv_e_fstat_var  TYPE CMS_DTE_FSTAT_VAR, "   
lv_e_actvt  TYPE CMS_DTE_PCN_ACTVT, "   
lv_e_tab_auth_actvt  TYPE CMS_TAB_PCN_ACTVT_PKY, "   
lv_e_tab_rc  TYPE CMS_TAB_MSG_COL_MESSAGE. "   

  CALL FUNCTION 'CMS_UI_PAT_EVENT_GET_UIP'  "Event Handler for GET UI Parameters of the Controller
    EXPORTING
         I_ENTITY_TYPE = lv_i_entity_type
         I_OBJ_ID = lv_i_obj_id
         I_ADMIN_ORG = lv_i_admin_org
         I_ACTIVITY = lv_i_activity
    IMPORTING
         E_OBJ_ID = lv_e_obj_id
         E_STR_PCN_PARAM = lv_e_str_pcn_param
         E_TAB_FLDVAL = lv_e_tab_fldval
         E_FSTAT_VAR = lv_e_fstat_var
         E_ACTVT = lv_e_actvt
         E_TAB_AUTH_ACTVT = lv_e_tab_auth_actvt
         E_TAB_RC = lv_e_tab_rc
. " CMS_UI_PAT_EVENT_GET_UIP




ABAP code using 7.40 inline data declarations to call FM CMS_UI_PAT_EVENT_GET_UIP

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!