SAP CMS_API_STATUS_MAINTAIN Function Module for Status display on dialog









CMS_API_STATUS_MAINTAIN is a standard cms api status maintain SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Status display on dialog 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 api status maintain FM, simply by entering the name CMS_API_STATUS_MAINTAIN into the relevant SAP transaction such as SE37 or SE38.

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



Function CMS_API_STATUS_MAINTAIN 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_API_STATUS_MAINTAIN'"Status display on dialog
EXPORTING
I_OBJECT_ID = "Object Identification number
* I_FLG_NO_STAT_PROF_CHG = ' ' "Indicator
* I_DYNNR = "ABAP program, number of current screen
* I_PROGNAME = "
* I_FLG_NO_SYS_STAT = ' ' "Indicator
* I_FLG_NO_USR_STAT = ' ' "Indicator
* I_FLG_DISP_ONLY = 'X' "Indicator
* I_FLG_CHG_DOC = 'X' "Indicator

IMPORTING
E_TAB_RC = "Return Code and corresponding Message
.



IMPORTING Parameters details for CMS_API_STATUS_MAINTAIN

I_OBJECT_ID - Object Identification number

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

I_FLG_NO_STAT_PROF_CHG - Indicator

Data type: CMS_DTE_FLG
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_DYNNR - ABAP program, number of current screen

Data type: SY-DYNNR
Optional: Yes
Call by Reference: Yes

I_PROGNAME -

Data type: SY-REPID
Optional: Yes
Call by Reference: Yes

I_FLG_NO_SYS_STAT - Indicator

Data type: CMS_DTE_FLG
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_FLG_NO_USR_STAT - Indicator

Data type: CMS_DTE_FLG
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_FLG_DISP_ONLY - Indicator

Data type: CMS_DTE_FLG
Default: 'X'
Optional: Yes
Call by Reference: Yes

I_FLG_CHG_DOC - Indicator

Data type: CMS_DTE_FLG
Default: 'X'
Optional: Yes
Call by Reference: Yes

EXPORTING Parameters details for CMS_API_STATUS_MAINTAIN

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_API_STATUS_MAINTAIN 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_tab_rc  TYPE CMS_TAB_MSG_COL_MESSAGE, "   
lv_i_object_id  TYPE CMS_DTE_OBJECT_ID, "   
lv_i_flg_no_stat_prof_chg  TYPE CMS_DTE_FLG, "   SPACE
lv_i_dynnr  TYPE SY-DYNNR, "   
lv_i_progname  TYPE SY-REPID, "   
lv_i_flg_no_sys_stat  TYPE CMS_DTE_FLG, "   SPACE
lv_i_flg_no_usr_stat  TYPE CMS_DTE_FLG, "   SPACE
lv_i_flg_disp_only  TYPE CMS_DTE_FLG, "   'X'
lv_i_flg_chg_doc  TYPE CMS_DTE_FLG. "   'X'

  CALL FUNCTION 'CMS_API_STATUS_MAINTAIN'  "Status display on dialog
    EXPORTING
         I_OBJECT_ID = lv_i_object_id
         I_FLG_NO_STAT_PROF_CHG = lv_i_flg_no_stat_prof_chg
         I_DYNNR = lv_i_dynnr
         I_PROGNAME = lv_i_progname
         I_FLG_NO_SYS_STAT = lv_i_flg_no_sys_stat
         I_FLG_NO_USR_STAT = lv_i_flg_no_usr_stat
         I_FLG_DISP_ONLY = lv_i_flg_disp_only
         I_FLG_CHG_DOC = lv_i_flg_chg_doc
    IMPORTING
         E_TAB_RC = lv_e_tab_rc
. " CMS_API_STATUS_MAINTAIN




ABAP code using 7.40 inline data declarations to call FM CMS_API_STATUS_MAINTAIN

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.

 
 
DATA(ld_i_flg_no_stat_prof_chg) = ' '.
 
"SELECT single DYNNR FROM SY INTO @DATA(ld_i_dynnr).
 
"SELECT single REPID FROM SY INTO @DATA(ld_i_progname).
 
DATA(ld_i_flg_no_sys_stat) = ' '.
 
DATA(ld_i_flg_no_usr_stat) = ' '.
 
DATA(ld_i_flg_disp_only) = 'X'.
 
DATA(ld_i_flg_chg_doc) = 'X'.
 


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!