SAP RPY_ENTITY_READ Function Module for Read entity type









RPY_ENTITY_READ is a standard rpy entity read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read entity type 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 rpy entity read FM, simply by entering the name RPY_ENTITY_READ into the relevant SAP transaction such as SE37 or SE38.

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



Function RPY_ENTITY_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 'RPY_ENTITY_READ'"Read entity type
  EXPORTING
*  CICO_MODE = 'R' "Checkin / checkout mode
*  WITH_OUTGOING_SPECIALIZATIONS = ' ' "Read with outgoing specializations?
*  WITH_INGOING_RELATIONSHIPS = 'X' "Read with ingoing relationships?
*  WITH_OUTGOING_RELATIONSHIPS = ' ' "Read with outgoing relationships?
*  WITH_OUTGOING_SPEC_CATEGORIES = 'X' "Read with outgoing specializations?
*  WITH_ASSIGNED_TABLE_OR_VIEW = 'X' "Read with table / view assignment?
*  WITH_WHERE_USED_LIST = ' ' "Read with where-used-list?
*  CICO_REQUEST_NO = ' ' "Checkin / check out administration number
   ENTITY_ID =  "ID of the entity type to be read
*  LANGUAGE = SY-LANGU "Language for reading the descriptions
*  WITH_ALIASES = 'X' "Read with alias names?
*  WITH_FORMATTED_DOCUMENTATION = ' ' "Read with formatted documentation?
*  WITH_SAPSCRIPT_DOCUMENTATION = 'X' "Read with SAPscript documentation?
*  WITH_ATTRIBUTES = 'X' "Read with attributes?
*  WITH_INGOING_SPECIALIZATIONS = 'X' "Read with ingoing specializations?

 IMPORTING
   ENTITY_INFO =  "Basic information on entity type
   ASSIGNED_TABLE_OR_VIEW =  "Table / view assignment

TABLES
   ERRORS =  "Error information
*  OUTGOING_SPEC_CATEGORIES =  "Specialization Types
*  WHERE_USED_LIST =  "Where-used List
*  ALIASES =  "Aliases
*  FORMATTED_DOCUMENTATION =  "Documentation in formatted form
*  SAPSCRIPT_DOCUMENTATION =  "Documentation in SAPscript form
*  ATTRIBUTES =  "Attributes
*  INGOING_SPECIALIZATIONS =  "Ingoing specializations
*  OUTGOING_SPECIALIZATIONS =  "Outgoing specializations
*  INGOING_RELATIONSHIPS =  "Ingoing relationships
*  OUTGOING_RELATIONSHIPS =  "Outgoing relationships
.



IMPORTING Parameters details for RPY_ENTITY_READ

CICO_MODE - Checkin / checkout mode

Data type: RPYDMGF-CICOMODE
Default: 'R'
Optional: Yes
Call by Reference: No ( called with pass by value option)

WITH_OUTGOING_SPECIALIZATIONS - Read with outgoing specializations?

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

WITH_INGOING_RELATIONSHIPS - Read with ingoing relationships?

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

WITH_OUTGOING_RELATIONSHIPS - Read with outgoing relationships?

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

WITH_OUTGOING_SPEC_CATEGORIES - Read with outgoing specializations?

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

WITH_ASSIGNED_TABLE_OR_VIEW - Read with table / view assignment?

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

WITH_WHERE_USED_LIST - Read with where-used-list?

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

CICO_REQUEST_NO - Checkin / check out administration number

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

ENTITY_ID - ID of the entity type to be read

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

LANGUAGE - Language for reading the descriptions

Data type: SY-LANGU
Default: SY-LANGU
Optional: Yes
Call by Reference: No ( called with pass by value option)

WITH_ALIASES - Read with alias names?

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

WITH_FORMATTED_DOCUMENTATION - Read with formatted documentation?

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

WITH_SAPSCRIPT_DOCUMENTATION - Read with SAPscript documentation?

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

WITH_ATTRIBUTES - Read with attributes?

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

WITH_INGOING_SPECIALIZATIONS - Read with ingoing specializations?

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

EXPORTING Parameters details for RPY_ENTITY_READ

ENTITY_INFO - Basic information on entity type

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

ASSIGNED_TABLE_OR_VIEW - Table / view assignment

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

TABLES Parameters details for RPY_ENTITY_READ

ERRORS - Error information

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

OUTGOING_SPEC_CATEGORIES - Specialization Types

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

WHERE_USED_LIST - Where-used List

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

ALIASES - Aliases

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

FORMATTED_DOCUMENTATION - Documentation in formatted form

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

SAPSCRIPT_DOCUMENTATION - Documentation in SAPscript form

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

ATTRIBUTES - Attributes

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

INGOING_SPECIALIZATIONS - Ingoing specializations

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

OUTGOING_SPECIALIZATIONS - Outgoing specializations

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

INGOING_RELATIONSHIPS - Ingoing relationships

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

OUTGOING_RELATIONSHIPS - Outgoing relationships

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

Copy and paste ABAP code example for RPY_ENTITY_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:
lt_errors  TYPE STANDARD TABLE OF RPYGSER, "   
lv_cico_mode  TYPE RPYDMGF-CICOMODE, "   'R'
lv_entity_info  TYPE RPYDMEN, "   
lt_outgoing_spec_categories  TYPE STANDARD TABLE OF RPYDMSC, "   
lv_with_outgoing_specializations  TYPE RPYDMGF-FLAG, "   SPACE
lt_where_used_list  TYPE STANDARD TABLE OF RPYDMHI, "   
lv_with_ingoing_relationships  TYPE RPYDMGF-FLAG, "   'X'
lv_with_outgoing_relationships  TYPE RPYDMGF-FLAG, "   SPACE
lv_with_outgoing_spec_categories  TYPE RPYDMGF-FLAG, "   'X'
lv_with_assigned_table_or_view  TYPE RPYDMGF-FLAG, "   'X'
lv_with_where_used_list  TYPE RPYDMGF-FLAG, "   SPACE
lt_aliases  TYPE STANDARD TABLE OF RPYDMAL, "   
lv_cico_request_no  TYPE RPYDMGF-CICOREQUNO, "   SPACE
lv_assigned_table_or_view  TYPE RPYDMTV, "   
lv_entity_id  TYPE RPYDMEN-ENTITY_ID, "   
lt_formatted_documentation  TYPE STANDARD TABLE OF RPYDMFD, "   
lv_language  TYPE SY-LANGU, "   SY-LANGU
lt_sapscript_documentation  TYPE STANDARD TABLE OF RPYDMSD, "   
lt_attributes  TYPE STANDARD TABLE OF RPYDMAT, "   
lv_with_aliases  TYPE RPYDMGF-FLAG, "   'X'
lt_ingoing_specializations  TYPE STANDARD TABLE OF RPYDMSP, "   
lv_with_formatted_documentation  TYPE RPYDMGF-FLAG, "   SPACE
lt_outgoing_specializations  TYPE STANDARD TABLE OF RPYDMSP, "   
lv_with_sapscript_documentation  TYPE RPYDMGF-FLAG, "   'X'
lv_with_attributes  TYPE RPYDMGF-FLAG, "   'X'
lt_ingoing_relationships  TYPE STANDARD TABLE OF RPYDMRL, "   
lt_outgoing_relationships  TYPE STANDARD TABLE OF RPYDMRL, "   
lv_with_ingoing_specializations  TYPE RPYDMGF-FLAG. "   'X'

  CALL FUNCTION 'RPY_ENTITY_READ'  "Read entity type
    EXPORTING
         CICO_MODE = lv_cico_mode
         WITH_OUTGOING_SPECIALIZATIONS = lv_with_outgoing_specializations
         WITH_INGOING_RELATIONSHIPS = lv_with_ingoing_relationships
         WITH_OUTGOING_RELATIONSHIPS = lv_with_outgoing_relationships
         WITH_OUTGOING_SPEC_CATEGORIES = lv_with_outgoing_spec_categories
         WITH_ASSIGNED_TABLE_OR_VIEW = lv_with_assigned_table_or_view
         WITH_WHERE_USED_LIST = lv_with_where_used_list
         CICO_REQUEST_NO = lv_cico_request_no
         ENTITY_ID = lv_entity_id
         LANGUAGE = lv_language
         WITH_ALIASES = lv_with_aliases
         WITH_FORMATTED_DOCUMENTATION = lv_with_formatted_documentation
         WITH_SAPSCRIPT_DOCUMENTATION = lv_with_sapscript_documentation
         WITH_ATTRIBUTES = lv_with_attributes
         WITH_INGOING_SPECIALIZATIONS = lv_with_ingoing_specializations
    IMPORTING
         ENTITY_INFO = lv_entity_info
         ASSIGNED_TABLE_OR_VIEW = lv_assigned_table_or_view
    TABLES
         ERRORS = lt_errors
         OUTGOING_SPEC_CATEGORIES = lt_outgoing_spec_categories
         WHERE_USED_LIST = lt_where_used_list
         ALIASES = lt_aliases
         FORMATTED_DOCUMENTATION = lt_formatted_documentation
         SAPSCRIPT_DOCUMENTATION = lt_sapscript_documentation
         ATTRIBUTES = lt_attributes
         INGOING_SPECIALIZATIONS = lt_ingoing_specializations
         OUTGOING_SPECIALIZATIONS = lt_outgoing_specializations
         INGOING_RELATIONSHIPS = lt_ingoing_relationships
         OUTGOING_RELATIONSHIPS = lt_outgoing_relationships
. " RPY_ENTITY_READ




ABAP code using 7.40 inline data declarations to call FM RPY_ENTITY_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 CICOMODE FROM RPYDMGF INTO @DATA(ld_cico_mode).
DATA(ld_cico_mode) = 'R'.
 
 
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_outgoing_specializations).
DATA(ld_with_outgoing_specializations) = ' '.
 
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_ingoing_relationships).
DATA(ld_with_ingoing_relationships) = 'X'.
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_outgoing_relationships).
DATA(ld_with_outgoing_relationships) = ' '.
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_outgoing_spec_categories).
DATA(ld_with_outgoing_spec_categories) = 'X'.
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_assigned_table_or_view).
DATA(ld_with_assigned_table_or_view) = 'X'.
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_where_used_list).
DATA(ld_with_where_used_list) = ' '.
 
 
"SELECT single CICOREQUNO FROM RPYDMGF INTO @DATA(ld_cico_request_no).
DATA(ld_cico_request_no) = ' '.
 
 
"SELECT single ENTITY_ID FROM RPYDMEN INTO @DATA(ld_entity_id).
 
 
"SELECT single LANGU FROM SY INTO @DATA(ld_language).
DATA(ld_language) = SY-LANGU.
 
 
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_aliases).
DATA(ld_with_aliases) = 'X'.
 
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_formatted_documentation).
DATA(ld_with_formatted_documentation) = ' '.
 
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_sapscript_documentation).
DATA(ld_with_sapscript_documentation) = 'X'.
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_attributes).
DATA(ld_with_attributes) = 'X'.
 
 
 
"SELECT single FLAG FROM RPYDMGF INTO @DATA(ld_with_ingoing_specializations).
DATA(ld_with_ingoing_specializations) = '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!