SAP SO_DOCUMENT_INSERT_API1 Function Module for SAPoffice: Create new office document using RFC

Search SAP Function Modules

SO_DOCUMENT_INSERT_API1 is a standard so document insert api1 SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for SAPoffice: Create new office document using RFC 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 so document insert api1 FM, simply by entering the name SO_DOCUMENT_INSERT_API1 into the relevant SAP transaction such as SE37 or SE38.

Function Group: SOI1
Program Name: SAPLSOI1
Main Program: SAPLSOI1
Appliation area: S
Release date: 14-Apr-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function SO_DOCUMENT_INSERT_API1 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 'SO_DOCUMENT_INSERT_API1'"SAPoffice: Create new office document using RFC
  EXPORTING
   FOLDER_ID =  "ID of folder in which document is to be created
   DOCUMENT_DATA =  "Document attributes (general header)
   DOCUMENT_TYPE =  "Document Class
*  IV_VSI_PROFILE =  "Virus Scan Profile

 IMPORTING
   DOCUMENT_INFO =  "Complete attributes of document

TABLES
*  OBJECT_HEADER =  "Header data for document (spec.header)
*  OBJECT_CONTENT =  "Document contents (text)
*  CONTENTS_HEX =  "Document contents (binary)
*  OBJECT_PARA =  "SET/GET parameter for processing
*  OBJECT_PARB =  "Fields and values for processing
*  ET_VSI_ERROR =  "Return Parameters

EXCEPTIONS
   FOLDER_NOT_EXIST = 1    DOCUMENT_TYPE_NOT_EXIST = 2    OPERATION_NO_AUTHORIZATION = 3    PARAMETER_ERROR = 4    X_ERROR = 5    ENQUEUE_ERROR = 6 

.

IMPORTING Parameters details for SO_DOCUMENT_INSERT_API1

FOLDER_ID - ID of folder in which document is to be created

Data type: SOOBJINFI1-OBJECT_ID
Optional: No
Call by Reference: No ( called with pass by value option)

DOCUMENT_DATA - Document attributes (general header)

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

DOCUMENT_TYPE - Document Class

Data type: SOODK-OBJTP
Optional: No
Call by Reference: No ( called with pass by value option)

IV_VSI_PROFILE - Virus Scan Profile

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

EXPORTING Parameters details for SO_DOCUMENT_INSERT_API1

DOCUMENT_INFO - Complete attributes of document

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

TABLES Parameters details for SO_DOCUMENT_INSERT_API1

OBJECT_HEADER - Header data for document (spec.header)

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

OBJECT_CONTENT - Document contents (text)

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

CONTENTS_HEX - Document contents (binary)

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

OBJECT_PARA - SET/GET parameter for processing

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

OBJECT_PARB - Fields and values for processing

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

ET_VSI_ERROR - Return Parameters

Data type: BAPIRET2
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

FOLDER_NOT_EXIST - Specified folder does not exist

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

DOCUMENT_TYPE_NOT_EXIST - Document type does not exist

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

OPERATION_NO_AUTHORIZATION - No authorization to create document

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

PARAMETER_ERROR - Invalid combination of parameter values

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

X_ERROR - Internal error or database inconsistency

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

ENQUEUE_ERROR - Required locks could not be set

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

Copy and paste ABAP code example for SO_DOCUMENT_INSERT_API1 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.

ABAP code using 7.40 inline data declarations to call FM SO_DOCUMENT_INSERT_API1

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.

Search for further information about these or an SAP related objects