SAP SO_DOCUMENT_READ_API1 Function Module for SAPoffice: View object from folder using RFC









SO_DOCUMENT_READ_API1 is a standard so document read 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: View object from folder 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 read api1 FM, simply by entering the name SO_DOCUMENT_READ_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_READ_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_READ_API1'"SAPoffice: View object from folder using RFC
  EXPORTING
   DOCUMENT_ID =  "ID of folder entry to be viewed
*  FILTER = 'X ' "Preselection of required object data

 IMPORTING
   DOCUMENT_DATA =  "Complete attributes of folder entry

TABLES
*  OBJECT_HEADER =  "Header data for document (spec.header)
*  OBJECT_CONTENT =  "Document Content
*  OBJECT_PARA =  "SET/GET parameter table for processing
*  OBJECT_PARB =  "Values transferred for processing
*  ATTACHMENT_LIST =  "Table with attachments for document
*  RECEIVER_LIST =  "Table with document recipients
*  CONTENTS_HEX =  "Table for Binary Content

EXCEPTIONS
   DOCUMENT_ID_NOT_EXIST = 1    OPERATION_NO_AUTHORIZATION = 2    X_ERROR = 3
.



IMPORTING Parameters details for SO_DOCUMENT_READ_API1

DOCUMENT_ID - ID of folder entry to be viewed

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

FILTER - Preselection of required object data

Data type: SOFILTERI1
Default: 'X '
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for SO_DOCUMENT_READ_API1

DOCUMENT_DATA - Complete attributes of folder entry

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

TABLES Parameters details for SO_DOCUMENT_READ_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)

OBJECT_PARA - SET/GET parameter table for processing

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

OBJECT_PARB - Values transferred for processing

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

ATTACHMENT_LIST - Table with attachments for document

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

RECEIVER_LIST - Table with document recipients

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

CONTENTS_HEX - Table for Binary Content

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

EXCEPTIONS details

DOCUMENT_ID_NOT_EXIST - Specified folder entry does not exist

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

OPERATION_NO_AUTHORIZATION - No authorization to view folder entry

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)

Copy and paste ABAP code example for SO_DOCUMENT_READ_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_document_data  TYPE SOFOLENTI1, "   
lt_object_header  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_document_id_not_exist  TYPE SOLISTI1, "   
lv_filter  TYPE SOFILTERI1, "   'X '
lt_object_content  TYPE STANDARD TABLE OF SOLISTI1, "   
lv_operation_no_authorization  TYPE SOLISTI1, "   
lv_x_error  TYPE SOLISTI1, "   
lt_object_para  TYPE STANDARD TABLE OF SOPARAI1, "   
lt_object_parb  TYPE STANDARD TABLE OF SOPARBI1, "   
lt_attachment_list  TYPE STANDARD TABLE OF SOATTLSTI1, "   
lt_receiver_list  TYPE STANDARD TABLE OF SORECLSTI1, "   
lt_contents_hex  TYPE STANDARD TABLE OF SOLIX. "   

  CALL FUNCTION 'SO_DOCUMENT_READ_API1'  "SAPoffice: View object from folder using RFC
    EXPORTING
         DOCUMENT_ID = lv_document_id
         FILTER = lv_filter
    IMPORTING
         DOCUMENT_DATA = lv_document_data
    TABLES
         OBJECT_HEADER = lt_object_header
         OBJECT_CONTENT = lt_object_content
         OBJECT_PARA = lt_object_para
         OBJECT_PARB = lt_object_parb
         ATTACHMENT_LIST = lt_attachment_list
         RECEIVER_LIST = lt_receiver_list
         CONTENTS_HEX = lt_contents_hex
    EXCEPTIONS
        DOCUMENT_ID_NOT_EXIST = 1
        OPERATION_NO_AUTHORIZATION = 2
        X_ERROR = 3
. " SO_DOCUMENT_READ_API1




ABAP code using 7.40 inline data declarations to call FM SO_DOCUMENT_READ_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).
 
 
 
 
DATA(ld_filter) = 'X '.
 
 
 
 
 
 
 
 
 


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!