SAP SO_OBJECT_READ Function Module for









SO_OBJECT_READ is a standard so object read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 object read FM, simply by entering the name SO_OBJECT_READ into the relevant SAP transaction such as SE37 or SE38.

Function Group: SOA1
Program Name: SAPLSOA1
Main Program: SAPLSOA1
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function SO_OBJECT_READ 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_OBJECT_READ'"
  EXPORTING
*  FILTER =  "
   FOLDER_ID =  "ID of folder which contains the object
*  FORWARDER =  "Object forwarder
   OBJECT_ID =  "ID of object
*  OWNER =  "Mailbox owner
*  F_MAILER = ' ' "

 IMPORTING
   OBJECT_FL_DISPLAY =  "Storage information about object
   OBJECT_HD_DISPLAY =  "Header data of object
   OBJECT_RC_DISPLAY =  "

TABLES
*  OBJCONT =  "Object contents
*  OBJHEAD =  "Object-specific header
*  OBJPARA =  "Parameters for processing the object
*  OBJPARB =  "Parameters for processing the object

EXCEPTIONS
   ACTIVE_USER_NOT_EXIST = 1    PARAMETER_ERROR = 10    SUBSTITUTE_NOT_ACTIVE = 11    SUBSTITUTE_NOT_DEFINED = 12    SYSTEM_FAILURE = 13    X_ERROR = 14    COMMUNICATION_FAILURE = 2    COMPONENT_NOT_AVAILABLE = 3    FOLDER_NOT_EXIST = 4    FOLDER_NO_AUTHORIZATION = 5    OBJECT_NOT_EXIST = 6    OBJECT_NO_AUTHORIZATION = 7    OPERATION_NO_AUTHORIZATION = 8    OWNER_NOT_EXIST = 9
.



IMPORTING Parameters details for SO_OBJECT_READ

FILTER -

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

FOLDER_ID - ID of folder which contains the object

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

FORWARDER - Object forwarder

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

OBJECT_ID - ID of object

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

OWNER - Mailbox owner

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

F_MAILER -

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

EXPORTING Parameters details for SO_OBJECT_READ

OBJECT_FL_DISPLAY - Storage information about object

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

OBJECT_HD_DISPLAY - Header data of object

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

OBJECT_RC_DISPLAY -

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

TABLES Parameters details for SO_OBJECT_READ

OBJCONT - Object contents

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

OBJHEAD - Object-specific header

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

OBJPARA - Parameters for processing the object

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

OBJPARB - Parameters for processing the object

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

EXCEPTIONS details

ACTIVE_USER_NOT_EXIST - Active user is not a SAPoffice user

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

PARAMETER_ERROR - Combination of parameter values not allowed

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

SUBSTITUTE_NOT_ACTIVE - Substitute not active

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

SUBSTITUTE_NOT_DEFINED - Substitute not defined

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

SYSTEM_FAILURE -

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

X_ERROR - Internal error

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

COMMUNICATION_FAILURE -

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

COMPONENT_NOT_AVAILABLE - SAPoffice component is not available

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

FOLDER_NOT_EXIST - Folder does not exist

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

FOLDER_NO_AUTHORIZATION - No authorization for folder

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

OBJECT_NOT_EXIST - Object does not exist

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

OBJECT_NO_AUTHORIZATION - No authorization for object

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

OPERATION_NO_AUTHORIZATION - No authorization for operation

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

OWNER_NOT_EXIST - Owner does not exist

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

Copy and paste ABAP code example for SO_OBJECT_READ 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_filter  TYPE SOFOR, "   
lt_objcont  TYPE STANDARD TABLE OF SOLI, "   
lv_object_fl_display  TYPE SOFM2, "   
lv_active_user_not_exist  TYPE SOFM2, "   
lv_parameter_error  TYPE SOFM2, "   
lv_substitute_not_active  TYPE SOFM2, "   
lv_substitute_not_defined  TYPE SOFM2, "   
lv_system_failure  TYPE SOFM2, "   
lv_x_error  TYPE SOFM2, "   
lt_objhead  TYPE STANDARD TABLE OF SOLI, "   
lv_folder_id  TYPE SOODK, "   
lv_object_hd_display  TYPE SOOD2, "   
lv_communication_failure  TYPE SOOD2, "   
lt_objpara  TYPE STANDARD TABLE OF SELC, "   
lv_forwarder  TYPE SOUD-USRNAM, "   
lv_object_rc_display  TYPE SOOS6, "   
lv_component_not_available  TYPE SOOS6, "   
lt_objparb  TYPE STANDARD TABLE OF SOOP1, "   
lv_object_id  TYPE SOODK, "   
lv_folder_not_exist  TYPE SOODK, "   
lv_owner  TYPE SOUD-USRNAM, "   
lv_folder_no_authorization  TYPE SOUD, "   
lv_f_mailer  TYPE SONV-USRROLE, "   SPACE
lv_object_not_exist  TYPE SONV, "   
lv_object_no_authorization  TYPE SONV, "   
lv_operation_no_authorization  TYPE SONV, "   
lv_owner_not_exist  TYPE SONV. "   

  CALL FUNCTION 'SO_OBJECT_READ'  "
    EXPORTING
         FILTER = lv_filter
         FOLDER_ID = lv_folder_id
         FORWARDER = lv_forwarder
         OBJECT_ID = lv_object_id
         OWNER = lv_owner
         F_MAILER = lv_f_mailer
    IMPORTING
         OBJECT_FL_DISPLAY = lv_object_fl_display
         OBJECT_HD_DISPLAY = lv_object_hd_display
         OBJECT_RC_DISPLAY = lv_object_rc_display
    TABLES
         OBJCONT = lt_objcont
         OBJHEAD = lt_objhead
         OBJPARA = lt_objpara
         OBJPARB = lt_objparb
    EXCEPTIONS
        ACTIVE_USER_NOT_EXIST = 1
        PARAMETER_ERROR = 10
        SUBSTITUTE_NOT_ACTIVE = 11
        SUBSTITUTE_NOT_DEFINED = 12
        SYSTEM_FAILURE = 13
        X_ERROR = 14
        COMMUNICATION_FAILURE = 2
        COMPONENT_NOT_AVAILABLE = 3
        FOLDER_NOT_EXIST = 4
        FOLDER_NO_AUTHORIZATION = 5
        OBJECT_NOT_EXIST = 6
        OBJECT_NO_AUTHORIZATION = 7
        OPERATION_NO_AUTHORIZATION = 8
        OWNER_NOT_EXIST = 9
. " SO_OBJECT_READ




ABAP code using 7.40 inline data declarations to call FM SO_OBJECT_READ

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 USRNAM FROM SOUD INTO @DATA(ld_forwarder).
 
 
 
 
 
 
"SELECT single USRNAM FROM SOUD INTO @DATA(ld_owner).
 
 
"SELECT single USRROLE FROM SONV INTO @DATA(ld_f_mailer).
DATA(ld_f_mailer) = ' '.
 
 
 
 
 


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!