SAP OCS_API_SOI_PREPARE Function Module for









OCS_API_SOI_PREPARE is a standard ocs api soi prepare SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 ocs api soi prepare FM, simply by entering the name OCS_API_SOI_PREPARE into the relevant SAP transaction such as SE37 or SE38.

Function Group: OCS_API
Program Name: SAPLOCS_API
Main Program: SAPLOCS_API
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function OCS_API_SOI_PREPARE 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 'OCS_API_SOI_PREPARE'"
EXPORTING
* IV_STACK_XML = "
* IV_DOWNLOAD_DIR = "
* IV_MT_TABLE_VERSION = '00000' "
* IV_CONTAINER = ' ' "
* IV_SCHEMA = ' ' "

IMPORTING
ET_PATQ = "
EV_RC = "
EV_MESSAGE = "
ES_MESSAGE = "
ET_MESSAGES = "
.



IMPORTING Parameters details for OCS_API_SOI_PREPARE

IV_STACK_XML -

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

IV_DOWNLOAD_DIR -

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

IV_MT_TABLE_VERSION -

Data type: VERSNO
Default: '00000'
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_CONTAINER -

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

IV_SCHEMA -

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

EXPORTING Parameters details for OCS_API_SOI_PREPARE

ET_PATQ -

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

EV_RC -

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

EV_MESSAGE -

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

ES_MESSAGE -

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

ET_MESSAGES -

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

Copy and paste ABAP code example for OCS_API_SOI_PREPARE 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_et_patq  TYPE TT_PAT_Q, "   
lv_iv_stack_xml  TYPE STRING, "   
lv_ev_rc  TYPE INT4, "   
lv_iv_download_dir  TYPE STRING, "   
lv_ev_message  TYPE PATCHTXT3, "   
lv_iv_mt_table_version  TYPE VERSNO, "   '00000'
lv_es_message  TYPE OCS_APIMSG, "   
lv_iv_container  TYPE OCS_MT_CONTAINER, "   SPACE
lv_iv_schema  TYPE OCS_MT_SCHEMA, "   SPACE
lv_et_messages  TYPE TTOCS_APIMSGS. "   

  CALL FUNCTION 'OCS_API_SOI_PREPARE'  "
    EXPORTING
         IV_STACK_XML = lv_iv_stack_xml
         IV_DOWNLOAD_DIR = lv_iv_download_dir
         IV_MT_TABLE_VERSION = lv_iv_mt_table_version
         IV_CONTAINER = lv_iv_container
         IV_SCHEMA = lv_iv_schema
    IMPORTING
         ET_PATQ = lv_et_patq
         EV_RC = lv_ev_rc
         EV_MESSAGE = lv_ev_message
         ES_MESSAGE = lv_es_message
         ET_MESSAGES = lv_et_messages
. " OCS_API_SOI_PREPARE




ABAP code using 7.40 inline data declarations to call FM OCS_API_SOI_PREPARE

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_iv_mt_table_version) = '00000'.
 
 
DATA(ld_iv_container) = ' '.
 
DATA(ld_iv_schema) = ' '.
 
 


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!