UMB_API_CE SAP Function module

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

Associated Function Group: UMB_API
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM UMB_API_CE - UMB API CE

CALL FUNCTION 'UMB_API_CE' "
  EXPORTING
    i_scard =                   " umb_y_scard
*   i_layout = 'X'              " as4flag
    i_detail =                  " int4
    i_curper =                  " umb_y_curper
    i_tarper =                  " umb_y_tarper
*   i_frper =                   " umc_y_validfr
*   i_toper =                   " umc_y_validto
*   i_est_col =                 " umb_y_col
*   it_text =                   " sotr_alias_tt
  IMPORTING
    e_output =                  " string
  EXCEPTIONS
    INVALID_SCARD = 1           "
    .  "  UMB_API_CE

ABAP code example for Function Module UMB_API_CE

The ABAP code below is a full code listing to execute function module UMB_API_CE 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_output  
 
 TYPE STRING
.


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

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

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

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

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

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

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

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

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

CALL FUNCTION 'UMB_API_CE'
  EXPORTING
    i_scard =                    ld_i_scard
*   i_layout =                   ld_i_layout
    i_detail =                   ld_i_detail
    i_curper =                   ld_i_curper
    i_tarper =                   ld_i_tarper
*   i_frper =                    ld_i_frper
*   i_toper =                    ld_i_toper
*   i_est_col =                  ld_i_est_col
*   it_text =                    ld_it_text
  IMPORTING
    e_output =                   ld_e_output
  EXCEPTIONS
    INVALID_SCARD =              1
    .  "  UMB_API_CE

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
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_output
 
 TYPE STRING ,
ld_i_scard
 
 TYPE UMB_Y_SCARD ,
ld_i_layout
 
 TYPE AS4FLAG ,
ld_i_detail
 
 TYPE INT4 ,
ld_i_curper
 
 TYPE UMB_Y_CURPER ,
ld_i_tarper
 
 TYPE UMB_Y_TARPER ,
ld_i_frper
 
 TYPE UMC_Y_VALIDFR ,
ld_i_toper
 
 TYPE UMC_Y_VALIDTO ,
ld_i_est_col
 
 TYPE UMB_Y_COL ,
ld_it_text
 
 TYPE SOTR_ALIAS_TT .


ld_i_scard = 'Check type of data required'.
ld_i_layout = 'Check type of data required'.
ld_i_detail = 'Check type of data required'.
ld_i_curper = 'Check type of data required'.
ld_i_tarper = 'Check type of data required'.
ld_i_frper = 'Check type of data required'.
ld_i_toper = 'Check type of data required'.
ld_i_est_col = 'Check type of data required'.
ld_it_text = 'Check type of data required'.