SAP SO_DOCUMENT_RECEIVE_API1 Function Module for SAPoffice: Receiving external documents with attachments
SO_DOCUMENT_RECEIVE_API1 is a standard so document receive 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: Receiving external documents with attachments 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 receive api1 FM, simply by entering the name SO_DOCUMENT_RECEIVE_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_RECEIVE_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_RECEIVE_API1'"SAPoffice: Receiving external documents with attachments.
EXPORTING
RECEIVE_INFO = "Information about document sender
DOCUMENT_DATA = "Document attributes
IMPORTING
SENT_TO_ALL = "Flag: Document sent to all
NEW_OBJECT_ID = "ID of created object (not document!)
COMMUNICATION_ID = "Send operation 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 document and attachments
* CONTENTS_HEX = "Binary contents of document and attachments
* OBJECT_PARA = "SET/GET parameter for processing
* OBJECT_PARB = "Fields and values for processing
RECEIVERS = "Document recipient
EXCEPTIONS
TOO_MANY_RECEIVERS = 1 OBJECT_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_RECEIVE_API1
RECEIVE_INFO - Information about document sender
Data type: SORECINFI1Optional: No
Call by Reference: No ( called with pass by value option)
DOCUMENT_DATA - Document attributes
Data type: SODOCCHGI1Optional: No
Call by Reference: No ( called with pass by value option)
EXPORTING Parameters details for SO_DOCUMENT_RECEIVE_API1
SENT_TO_ALL - Flag: Document sent to all
Data type: SONV-FLAGOptional: No
Call by Reference: No ( called with pass by value option)
NEW_OBJECT_ID - ID of created object (not document!)
Data type: SOFOLENTI1-OBJECT_IDOptional: No
Call by Reference: No ( called with pass by value option)
COMMUNICATION_ID - Send operation ID
Data type: SORECINFI1-COMM_IDOptional: No
Call by Reference: No ( called with pass by value option)
TABLES Parameters details for SO_DOCUMENT_RECEIVE_API1
PACKING_LIST - Information about structure of data tables
Data type: SOPCKLSTI1Optional: No
Call by Reference: No ( called with pass by value option)
OBJECT_HEADER - Header data for document (spec.header)
Data type: SOLISTI1Optional: Yes
Call by Reference: No ( called with pass by value option)
CONTENTS_BIN - Obsolete, see CONTENTS_HEX
Data type: SOLISTI1Optional: Yes
Call by Reference: No ( called with pass by value option)
CONTENTS_TXT - ASCII contents of document and attachments
Data type: SOLISTI1Optional: Yes
Call by Reference: No ( called with pass by value option)
CONTENTS_HEX - Binary contents of document and attachments
Data type: SOLIXOptional: Yes
Call by Reference: No ( called with pass by value option)
OBJECT_PARA - SET/GET parameter for processing
Data type: SOPARAI1Optional: Yes
Call by Reference: No ( called with pass by value option)
OBJECT_PARB - Fields and values for processing
Data type: SOPARBI1Optional: Yes
Call by Reference: No ( called with pass by value option)
RECEIVERS - Document recipient
Data type: SOEXTRECI1Optional: No
Call by Reference: No ( called with pass by value option)
EXCEPTIONS details
TOO_MANY_RECEIVERS - Too many recipients, no authorization
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
OBJECT_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_RECEIVE_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_receive_info | TYPE SORECINFI1, " | |||
lv_too_many_receivers | TYPE SORECINFI1, " | |||
lv_document_data | TYPE SODOCCHGI1, " | |||
lv_new_object_id | TYPE SOFOLENTI1-OBJECT_ID, " | |||
lt_object_header | TYPE STANDARD TABLE OF SOLISTI1, " | |||
lv_object_not_sent | TYPE SOLISTI1, " | |||
lt_contents_bin | TYPE STANDARD TABLE OF SOLISTI1, " | |||
lv_communication_id | TYPE SORECINFI1-COMM_ID, " | |||
lv_document_type_not_exist | TYPE SORECINFI1, " | |||
lt_contents_txt | TYPE STANDARD TABLE OF SOLISTI1, " | |||
lv_operation_no_authorization | TYPE SOLISTI1, " | |||
lt_contents_hex | TYPE STANDARD TABLE OF SOLIX, " | |||
lv_parameter_error | TYPE SOLIX, " | |||
lv_x_error | TYPE SOLIX, " | |||
lt_object_para | TYPE STANDARD TABLE OF SOPARAI1, " | |||
lt_object_parb | TYPE STANDARD TABLE OF SOPARBI1, " | |||
lv_enqueue_error | TYPE SOPARBI1, " | |||
lt_receivers | TYPE STANDARD TABLE OF SOEXTRECI1. " |
  CALL FUNCTION 'SO_DOCUMENT_RECEIVE_API1' "SAPoffice: Receiving external documents with attachments |
EXPORTING | ||
RECEIVE_INFO | = lv_receive_info | |
DOCUMENT_DATA | = lv_document_data | |
IMPORTING | ||
SENT_TO_ALL | = lv_sent_to_all | |
NEW_OBJECT_ID | = lv_new_object_id | |
COMMUNICATION_ID | = lv_communication_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 | |
EXCEPTIONS | ||
TOO_MANY_RECEIVERS = 1 | ||
OBJECT_NOT_SENT = 2 | ||
DOCUMENT_TYPE_NOT_EXIST = 3 | ||
OPERATION_NO_AUTHORIZATION = 4 | ||
PARAMETER_ERROR = 5 | ||
X_ERROR = 6 | ||
ENQUEUE_ERROR = 7 | ||
. " SO_DOCUMENT_RECEIVE_API1 |
ABAP code using 7.40 inline data declarations to call FM SO_DOCUMENT_RECEIVE_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 COMM_ID FROM SORECINFI1 INTO @DATA(ld_communication_id). | ||||
Search for further information about these or an SAP related objects