SAP SO_ATTACHMENT_INSERT_API1 Function Module for SAPoffice: Create attachment using RFC









SO_ATTACHMENT_INSERT_API1 is a standard so attachment 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 attachment 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 attachment insert api1 FM, simply by entering the name SO_ATTACHMENT_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_ATTACHMENT_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_ATTACHMENT_INSERT_API1'"SAPoffice: Create attachment using RFC
EXPORTING
DOCUMENT_ID = "ID of Document for Which Attachment Is to Be Created
ATTACHMENT_DATA = "Attributes of New Attachment
ATTACHMENT_TYPE = "Document Class for Attachment
* IV_VSI_PROFILE = "Virus Scan Profile

IMPORTING
ATTACHMENT_INFO = "Complete Attributes After Creation

TABLES
ATTACHMENT_HEADER = "Header Data for Attachment (Spec.Header)
ATTACHMENT_CONTENT = "Attachment Contents
* CONTENTS_HEX = "Attachment Contents (Binary)
* ET_VSI_ERROR = "Return parameters

EXCEPTIONS
DOCUMENT_NOT_EXIST = 1 ATTACHMENT_TYPE_NOT_EXIST = 2 OPERATION_NO_AUTHORIZATION = 3 PARAMETER_ERROR = 4 X_ERROR = 5 ENQUEUE_ERROR = 6
.



IMPORTING Parameters details for SO_ATTACHMENT_INSERT_API1

DOCUMENT_ID - ID of Document for Which Attachment Is to Be Created

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

ATTACHMENT_DATA - Attributes of New Attachment

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

ATTACHMENT_TYPE - Document Class for Attachment

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_ATTACHMENT_INSERT_API1

ATTACHMENT_INFO - Complete Attributes After Creation

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

TABLES Parameters details for SO_ATTACHMENT_INSERT_API1

ATTACHMENT_HEADER - Header Data for Attachment (Spec.Header)

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

ATTACHMENT_CONTENT - Attachment Contents

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

CONTENTS_HEX - Attachment Contents (Binary)

Data type: SOLIX
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

DOCUMENT_NOT_EXIST - Specified Document Does Not Exist

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

ATTACHMENT_TYPE_NOT_EXIST - Document Type for Attachment Does Not Exist

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

OPERATION_NO_AUTHORIZATION - No Authorization to Create Attachment

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_ATTACHMENT_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.

DATA:
lv_document_id  TYPE SOFOLENTI1-DOC_ID, "   
lv_attachment_info  TYPE SOATTINFI1, "   
lt_attachment_header  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_document_not_exist  TYPE SOLISTI1, "   
lv_attachment_data  TYPE SOATTCHGI1, "   
lt_attachment_content  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_attachment_type_not_exist  TYPE SOLISTI1, "   
lt_contents_hex  TYPE STANDARD TABLE OF SOLIX, "   
lv_attachment_type  TYPE SOODK-OBJTP, "   
lv_operation_no_authorization  TYPE SOODK, "   
lt_et_vsi_error  TYPE STANDARD TABLE OF BAPIRET2, "   
lv_iv_vsi_profile  TYPE VSCAN_PROFILE, "   
lv_parameter_error  TYPE VSCAN_PROFILE, "   
lv_x_error  TYPE VSCAN_PROFILE, "   
lv_enqueue_error  TYPE VSCAN_PROFILE. "   

  CALL FUNCTION 'SO_ATTACHMENT_INSERT_API1'  "SAPoffice: Create attachment using RFC
    EXPORTING
         DOCUMENT_ID = lv_document_id
         ATTACHMENT_DATA = lv_attachment_data
         ATTACHMENT_TYPE = lv_attachment_type
         IV_VSI_PROFILE = lv_iv_vsi_profile
    IMPORTING
         ATTACHMENT_INFO = lv_attachment_info
    TABLES
         ATTACHMENT_HEADER = lt_attachment_header
         ATTACHMENT_CONTENT = lt_attachment_content
         CONTENTS_HEX = lt_contents_hex
         ET_VSI_ERROR = lt_et_vsi_error
    EXCEPTIONS
        DOCUMENT_NOT_EXIST = 1
        ATTACHMENT_TYPE_NOT_EXIST = 2
        OPERATION_NO_AUTHORIZATION = 3
        PARAMETER_ERROR = 4
        X_ERROR = 5
        ENQUEUE_ERROR = 6
. " SO_ATTACHMENT_INSERT_API1




ABAP code using 7.40 inline data declarations to call FM SO_ATTACHMENT_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.

"SELECT single DOC_ID FROM SOFOLENTI1 INTO @DATA(ld_document_id).
 
 
 
 
 
 
 
 
"SELECT single OBJTP FROM SOODK INTO @DATA(ld_attachment_type).
 
 
 
 
 
 
 


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!