SAP Function Modules

comments icon Comments

UPX_API_INIT SAP Function module - UPX: Initialize the communication with the engine







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

Associated Function Group: UPX_API
Released Date: Not Released
Processing type: Remote-Enabled
remote enabled module settings


Pattern for FM UPX_API_INIT - UPX API INIT 





CALL FUNCTION 'UPX_API_INIT' "UPX: Initialize the communication with the engine
* EXPORTING
*   i_area =                    " upx_api_ys_main-area  Planning Area
  IMPORTING
    e_dcpfm =                   " upx_api_ys_main-dcpfm  Decimal Notation
* TABLES
*   et_chapro =                 " upc_ys_api_chapro  Properties of a characteristic
*   et_kyfpro =                 " upc_ys_kyfpro  Key Figure Properties
*   et_status =                 " upx_ys_status  UPX: Status of the LaunchPad Item - Runtime Version
*   et_return =                 " bapiret2      Return Parameter
    .  "  UPX_API_INIT

ABAP code example for Function Module UPX_API_INIT





The ABAP code below is a full code listing to execute function module UPX_API_INIT 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_dcpfm    TYPE UPX_API_YS_MAIN-DCPFM
,
it_et_chapro    TYPE STANDARD TABLE OF UPC_YS_API_CHAPRO,"TABLES PARAM
wa_et_chapro  LIKE LINE OF it_et_chapro
,
it_et_kyfpro    TYPE STANDARD TABLE OF UPC_YS_KYFPRO,"TABLES PARAM
wa_et_kyfpro  LIKE LINE OF it_et_kyfpro
,
it_et_status    TYPE STANDARD TABLE OF UPX_YS_STATUS,"TABLES PARAM
wa_et_status  LIKE LINE OF it_et_status
,
it_et_return    TYPE STANDARD TABLE OF BAPIRET2,"TABLES PARAM
wa_et_return  LIKE LINE OF it_et_return
.





DATA(ld_i_area) = some text here
 

"populate fields of struture and append to itab
append wa_et_chapro to it_et_chapro.
 

"populate fields of struture and append to itab
append wa_et_kyfpro to it_et_kyfpro.
 

"populate fields of struture and append to itab
append wa_et_status to it_et_status.
 

"populate fields of struture and append to itab
append wa_et_return to it_et_return.
.

CALL FUNCTION 'UPX_API_INIT'
* EXPORTING
*   i_area =                     ld_i_area
  IMPORTING
    e_dcpfm =                    ld_e_dcpfm
* TABLES
*   et_chapro =                  it_et_chapro
*   et_kyfpro =                  it_et_kyfpro
*   et_status =                  it_et_status
*   et_return =                  it_et_return
    .  "  UPX_API_INIT

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_dcpfm  TYPE UPX_API_YS_MAIN-DCPFM ,
ld_i_area  TYPE UPX_API_YS_MAIN-AREA ,
it_et_chapro  TYPE STANDARD TABLE OF UPC_YS_API_CHAPRO ,
wa_et_chapro  LIKE LINE OF it_et_chapro,
it_et_kyfpro  TYPE STANDARD TABLE OF UPC_YS_KYFPRO ,
wa_et_kyfpro  LIKE LINE OF it_et_kyfpro,
it_et_status  TYPE STANDARD TABLE OF UPX_YS_STATUS ,
wa_et_status  LIKE LINE OF it_et_status,
it_et_return  TYPE STANDARD TABLE OF BAPIRET2 ,
wa_et_return  LIKE LINE OF it_et_return.





ld_i_area = some text here 

"populate fields of struture and append to itab
append wa_et_chapro to it_et_chapro. 

"populate fields of struture and append to itab
append wa_et_kyfpro to it_et_kyfpro. 

"populate fields of struture and append to itab
append wa_et_status to it_et_status. 

"populate fields of struture and append to itab
append wa_et_return to it_et_return.

Contribute (Add Comments)

Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name UPX_API_INIT or its description.


   
 

UPX_API_INIT - UPX: Initialize the communication with the engine
UPX_API_FUNC_EXEC - API: Execute planning function
UPX_API_DONE - UPX: Final API after all work is done
UPX_API_DATA_SET - Write data of a planning object to the buffer
UPX_API_DATA_GET - Read data object to a planning
UPX_API_COMMIT - UPX ext. API: commit BPS buffers