CMS_UI_PCN_START SAP Function module - Process control UI start logic

CMS_UI_PCN_START 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 CMS_UI_PCN_START into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: CMS_UI_PCN
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM CMS_UI_PCN_START - CMS UI PCN START

CALL FUNCTION 'CMS_UI_PCN_START' "Process control UI start logic
  EXPORTING
    i_proc_obj =                " cms_dte_pcn_proc_obj  Process object
    i_proc_cky =                " cms_dte_pcn_proc_cky  Process control key
    i_proc_area =               " cms_dte_pcn_area  Process Control Area
*   i_cr_type = SPACE           " cms_dte_pcn_cr_typ  Change Request Type
*   i_activity =                " cms_dte_pcn_actvt  Activity ID
*   i_ui_var =                  " cms_dte_fstat_var  Object Screen (Field Status Variant)
*   i_object_id =               " cms_dte_object_id  Object Identification number
*   i_tab_fld_val =             " cms_tab_fldval  Table of field values
*   i_str_cursor_position =     " cms_str_cursor_position  Parameters for Cursor position
*   i_tab_auth_actvt =          " cms_tab_pcn_actvt_pky  Activities
  IMPORTING
    e_dynnr =                   " sydynnr       ABAP program, number of current screen
    e_programme =               " progname      ABAP program name
    e_title =                   " sytitle       Screens, title text
    e_tab_rc =                  " cms_tab_msg_col_message  Return Code and corresponding Message
    .  "  CMS_UI_PCN_START

ABAP code example for Function Module CMS_UI_PCN_START

The ABAP code below is a full code listing to execute function module CMS_UI_PCN_START 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_e_dynnr  
 
 TYPE SYDYNNR
,
ld_e_programme  
 
 TYPE PROGNAME
,
ld_e_title  
 
 TYPE SYTITLE
,
ld_e_tab_rc  
 
 TYPE CMS_TAB_MSG_COL_MESSAGE
.


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

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

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

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

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

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

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

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

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

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

CALL FUNCTION 'CMS_UI_PCN_START'
  EXPORTING
    i_proc_obj =                 ld_i_proc_obj
    i_proc_cky =                 ld_i_proc_cky
    i_proc_area =                ld_i_proc_area
*   i_cr_type =                  ld_i_cr_type
*   i_activity =                 ld_i_activity
*   i_ui_var =                   ld_i_ui_var
*   i_object_id =                ld_i_object_id
*   i_tab_fld_val =              ld_i_tab_fld_val
*   i_str_cursor_position =      ld_i_str_cursor_position
*   i_tab_auth_actvt =           ld_i_tab_auth_actvt
  IMPORTING
    e_dynnr =                    ld_e_dynnr
    e_programme =                ld_e_programme
    e_title =                    ld_e_title
    e_tab_rc =                   ld_e_tab_rc
    .  "  CMS_UI_PCN_START

IF SY-SUBRC EQ 0.
  "All OK
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_e_dynnr
 
 TYPE SYDYNNR ,
ld_i_proc_obj
 
 TYPE CMS_DTE_PCN_PROC_OBJ ,
ld_e_programme
 
 TYPE PROGNAME ,
ld_i_proc_cky
 
 TYPE CMS_DTE_PCN_PROC_CKY ,
ld_e_title
 
 TYPE SYTITLE ,
ld_i_proc_area
 
 TYPE CMS_DTE_PCN_AREA ,
ld_e_tab_rc
 
 TYPE CMS_TAB_MSG_COL_MESSAGE ,
ld_i_cr_type
 
 TYPE CMS_DTE_PCN_CR_TYP ,
ld_i_activity
 
 TYPE CMS_DTE_PCN_ACTVT ,
ld_i_ui_var
 
 TYPE CMS_DTE_FSTAT_VAR ,
ld_i_object_id
 
 TYPE CMS_DTE_OBJECT_ID ,
ld_i_tab_fld_val
 
 TYPE CMS_TAB_FLDVAL ,
ld_i_str_cursor_position
 
 TYPE CMS_STR_CURSOR_POSITION ,
ld_i_tab_auth_actvt
 
 TYPE CMS_TAB_PCN_ACTVT_PKY .


ld_i_proc_obj = 'Check type of data required'.
ld_i_proc_cky = 'Check type of data required'.
ld_i_proc_area = 'Check type of data required'.
ld_i_cr_type = 'Check type of data required'.
ld_i_activity = 'Check type of data required'.
ld_i_ui_var = 'Check type of data required'.
ld_i_object_id = 'Check type of data required'.
ld_i_tab_fld_val = 'Check type of data required'.
ld_i_str_cursor_position = 'Check type of data required'.
ld_i_tab_auth_actvt = 'Check type of data required'.