SAP SO_USER_READ_API1 Function Module for SAPoffice: View SAPoffice user data using RFC









SO_USER_READ_API1 is a standard so user 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 SAPoffice user data 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 user read api1 FM, simply by entering the name SO_USER_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_USER_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_USER_READ_API1'"SAPoffice: View SAPoffice user data using RFC
EXPORTING
* USER = ' ' "Structure with name or ID of user
* PREPARE_FOR_FOLDER_ACCESS = ' ' "Flag: Daily initialization of user

IMPORTING
USER_DATA = "User data

EXCEPTIONS
USER_NOT_EXIST = 1 PARAMETER_ERROR = 2 X_ERROR = 3
.



IMPORTING Parameters details for SO_USER_READ_API1

USER - Structure with name or ID of user

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

PREPARE_FOR_FOLDER_ACCESS - Flag: Daily initialization of user

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

EXPORTING Parameters details for SO_USER_READ_API1

USER_DATA - User data

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

EXCEPTIONS details

USER_NOT_EXIST - Specified ID or user name does not exist

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)

Copy and paste ABAP code example for SO_USER_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_user  TYPE SOUDNAMEI1, "   SPACE
lv_user_data  TYPE SOUDATAI1, "   
lv_user_not_exist  TYPE SOUDATAI1, "   
lv_parameter_error  TYPE SOUDATAI1, "   
lv_prepare_for_folder_access  TYPE SONV-FLAG, "   SPACE
lv_x_error  TYPE SONV. "   

  CALL FUNCTION 'SO_USER_READ_API1'  "SAPoffice: View SAPoffice user data using RFC
    EXPORTING
         USER = lv_user
         PREPARE_FOR_FOLDER_ACCESS = lv_prepare_for_folder_access
    IMPORTING
         USER_DATA = lv_user_data
    EXCEPTIONS
        USER_NOT_EXIST = 1
        PARAMETER_ERROR = 2
        X_ERROR = 3
. " SO_USER_READ_API1




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

DATA(ld_user) = ' '.
 
 
 
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_prepare_for_folder_access).
DATA(ld_prepare_for_folder_access) = ' '.
 
 


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!