SAP SO_SMALL_DOCUMENT_RECEIVE_API1 Function Module for SAPoffice: Receive documents from another mail system

Search SAP Function Modules

SO_SMALL_DOCUMENT_RECEIVE_API1 is a standard so small 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: Receive documents from another mail system 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 small document receive api1 FM, simply by entering the name SO_SMALL_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_SMALL_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_SMALL_DOCUMENT_RECEIVE_API1'"SAPoffice: Receive documents from another mail system
  EXPORTING
   RECEIVE_INFO =  "Information about document sender
   DOCUMENT_DATA =  "Document attributes
   DOCUMENT_TYPE =  "Document Type

 IMPORTING
   SENT_TO_ALL =  "Flag: Document was sent to all
   NEW_OBJECT_ID =  "Object ID of created document
   COMMUNICATION_ID =  "Send operation ID

TABLES
*  OBJECT_HEADER =  "Header data for document (spec.header)
*  OBJECT_CONTENT =  "Document Content
*  CONTENTS_HEX =  "Document contents (binary)
*  OBJECT_PARA =  "SET/GET parameter for processing
*  OBJECT_PARB =  "Fields and values for processing
   RECEIVERS =  "Document recipients with send attributes

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

.

IMPORTING Parameters details for SO_SMALL_DOCUMENT_RECEIVE_API1

RECEIVE_INFO - Information about document sender

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

DOCUMENT_DATA - Document attributes

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

DOCUMENT_TYPE - Document Type

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

EXPORTING Parameters details for SO_SMALL_DOCUMENT_RECEIVE_API1

SENT_TO_ALL - Flag: Document was sent to all

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

NEW_OBJECT_ID - Object ID of created document

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

COMMUNICATION_ID - Send operation ID

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

TABLES Parameters details for SO_SMALL_DOCUMENT_RECEIVE_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 Content

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)

RECEIVERS - Document recipients with send attributes

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

EXCEPTIONS details

OBJECT_NOT_SENT - Object was not sent

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

DOCUMENT_TYPE_NOT_EXIST - Unknown object type

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

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

Search for further information about these or an SAP related objects