SAP SO_DOCUMENT_SEND_API1 Function Module for SAPoffice: Send new document with attachments using RFC









SO_DOCUMENT_SEND_API1 is a standard so document send 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: Send new document with attachments 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 send api1 FM, simply by entering the name SO_DOCUMENT_SEND_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_SEND_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_SEND_API1'"SAPoffice: Send new document with attachments using RFC
  EXPORTING
   DOCUMENT_DATA =  "Attributes of new document
*  PUT_IN_OUTBOX = ' ' "Flag: Move document to outbox after send
*  SENDER_ADDRESS = SY-UNAME "
*  SENDER_ADDRESS_TYPE = 'B' "
*  COMMIT_WORK = ' ' "Execute explicit commit works at end of function module
*  IP_ENCRYPT =  "Indicator: Encryption Required
*  IP_SIGN =  "Indicator: Signature Required
*  IV_VSI_PROFILE =  "Virus Scan Profile

 IMPORTING
   SENT_TO_ALL =  "Flag: Document sent to all
   NEW_OBJECT_ID =  "ID of created object (not document!)
   SENDER_ID =  "

TABLES
   PACKING_LIST =  "Information about structure of data tables
*  OBJECT_HEADER =  "Header data for document (spec.header)
*  CONTENTS_BIN =  "Obsolete - see CONTENTS_HEX
*  CONTENTS_TXT =  "ASCII contents of object and attachments
*  CONTENTS_HEX =  "Binary contents of object and attachments
*  OBJECT_PARA =  "SET/GET parameter for processing
*  OBJECT_PARB =  "Fields and values for processing
   RECEIVERS =  "Document recipients with send attributes
*  ET_VSI_ERROR =  "Return Parameters

EXCEPTIONS
   TOO_MANY_RECEIVERS = 1    DOCUMENT_NOT_SENT = 2    DOCUMENT_TYPE_NOT_EXIST = 3    OPERATION_NO_AUTHORIZATION = 4    PARAMETER_ERROR = 5    X_ERROR = 6    ENQUEUE_ERROR = 7
.



IMPORTING Parameters details for SO_DOCUMENT_SEND_API1

DOCUMENT_DATA - Attributes of new document

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

PUT_IN_OUTBOX - Flag: Move document to outbox after send

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

SENDER_ADDRESS -

Data type: SOEXTRECI1-RECEIVER
Default: SY-UNAME
Optional: Yes
Call by Reference: No ( called with pass by value option)

SENDER_ADDRESS_TYPE -

Data type: SOEXTRECI1-ADR_TYP
Default: 'B'
Optional: Yes
Call by Reference: No ( called with pass by value option)

COMMIT_WORK - Execute explicit commit works at end of function module

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

IP_ENCRYPT - Indicator: Encryption Required

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

IP_SIGN - Indicator: Signature Required

Data type: BCSD_SIGN
Optional: Yes
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_SEND_API1

SENT_TO_ALL - Flag: Document sent to all

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

NEW_OBJECT_ID - ID of created object (not document!)

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

SENDER_ID -

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

TABLES Parameters details for SO_DOCUMENT_SEND_API1

PACKING_LIST - Information about structure of data tables

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

OBJECT_HEADER - Header data for document (spec.header)

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

CONTENTS_BIN - Obsolete - see CONTENTS_HEX

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

CONTENTS_TXT - ASCII contents of object and attachments

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

CONTENTS_HEX - Binary contents of object and attachments

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)

RECEIVERS - Document recipients with send attributes

Data type: SOMLRECI1
Optional: No
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

TOO_MANY_RECEIVERS - Too many recipients, no authorization

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

DOCUMENT_NOT_SENT - Document was not sent

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

DOCUMENT_TYPE_NOT_EXIST - Document type or attachment type does not exist

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

OPERATION_NO_AUTHORIZATION - No authorization to send/create

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_SEND_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_sent_to_all  TYPE SONV-FLAG, "   
lt_packing_list  TYPE STANDARD TABLE OF SOPCKLSTI1, "   
lv_document_data  TYPE SODOCCHGI1, "   
lv_too_many_receivers  TYPE SODOCCHGI1, "   
lv_new_object_id  TYPE SOFOLENTI1-OBJECT_ID, "   
lt_object_header  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_put_in_outbox  TYPE SONV-FLAG, "   SPACE
lv_document_not_sent  TYPE SONV, "   
lv_sender_id  TYPE SOUDK, "   
lt_contents_bin  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_sender_address  TYPE SOEXTRECI1-RECEIVER, "   SY-UNAME
lv_document_type_not_exist  TYPE SOEXTRECI1, "   
lt_contents_txt  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_sender_address_type  TYPE SOEXTRECI1-ADR_TYP, "   'B'
lv_operation_no_authorization  TYPE SOEXTRECI1, "   
lv_commit_work  TYPE SONV-FLAG, "   SPACE
lt_contents_hex  TYPE STANDARD TABLE OF SOLIX, "   
lv_parameter_error  TYPE SOLIX, "   
lv_x_error  TYPE SOLIX, "   
lv_ip_encrypt  TYPE BCSD_ENCR, "   
lt_object_para  TYPE STANDARD TABLE OF SOPARAI1, "   
lv_ip_sign  TYPE BCSD_SIGN, "   
lt_object_parb  TYPE STANDARD TABLE OF SOPARBI1, "   
lv_enqueue_error  TYPE SOPARBI1, "   
lt_receivers  TYPE STANDARD TABLE OF SOMLRECI1, "   
lv_iv_vsi_profile  TYPE VSCAN_PROFILE, "   
lt_et_vsi_error  TYPE STANDARD TABLE OF BAPIRET2. "   

  CALL FUNCTION 'SO_DOCUMENT_SEND_API1'  "SAPoffice: Send new document with attachments using RFC
    EXPORTING
         DOCUMENT_DATA = lv_document_data
         PUT_IN_OUTBOX = lv_put_in_outbox
         SENDER_ADDRESS = lv_sender_address
         SENDER_ADDRESS_TYPE = lv_sender_address_type
         COMMIT_WORK = lv_commit_work
         IP_ENCRYPT = lv_ip_encrypt
         IP_SIGN = lv_ip_sign
         IV_VSI_PROFILE = lv_iv_vsi_profile
    IMPORTING
         SENT_TO_ALL = lv_sent_to_all
         NEW_OBJECT_ID = lv_new_object_id
         SENDER_ID = lv_sender_id
    TABLES
         PACKING_LIST = lt_packing_list
         OBJECT_HEADER = lt_object_header
         CONTENTS_BIN = lt_contents_bin
         CONTENTS_TXT = lt_contents_txt
         CONTENTS_HEX = lt_contents_hex
         OBJECT_PARA = lt_object_para
         OBJECT_PARB = lt_object_parb
         RECEIVERS = lt_receivers
         ET_VSI_ERROR = lt_et_vsi_error
    EXCEPTIONS
        TOO_MANY_RECEIVERS = 1
        DOCUMENT_NOT_SENT = 2
        DOCUMENT_TYPE_NOT_EXIST = 3
        OPERATION_NO_AUTHORIZATION = 4
        PARAMETER_ERROR = 5
        X_ERROR = 6
        ENQUEUE_ERROR = 7
. " SO_DOCUMENT_SEND_API1




ABAP code using 7.40 inline data declarations to call FM SO_DOCUMENT_SEND_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 FLAG FROM SONV INTO @DATA(ld_sent_to_all).
 
 
 
 
"SELECT single OBJECT_ID FROM SOFOLENTI1 INTO @DATA(ld_new_object_id).
 
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_put_in_outbox).
DATA(ld_put_in_outbox) = ' '.
 
 
 
 
"SELECT single RECEIVER FROM SOEXTRECI1 INTO @DATA(ld_sender_address).
DATA(ld_sender_address) = SY-UNAME.
 
 
 
"SELECT single ADR_TYP FROM SOEXTRECI1 INTO @DATA(ld_sender_address_type).
DATA(ld_sender_address_type) = 'B'.
 
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_commit_work).
DATA(ld_commit_work) = ' '.
 
 
 
 
 
 
 
 
 
 
 
 


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!