SAP RSOD_BIRM_QUERY Function Module for Search BI Documents Using Class and Query

Search SAP Function Modules

RSOD_BIRM_QUERY is a standard rsod birm query SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Search BI Documents Using Class and Query 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 rsod birm query FM, simply by entering the name RSOD_BIRM_QUERY into the relevant SAP transaction such as SE37 or SE38.

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

Function RSOD_BIRM_QUERY 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 'RSOD_BIRM_QUERY'"Search BI Documents Using Class and Query
  EXPORTING
   I_DOC_CLASS =  "Document Class
   I_T_QUPROP =  "Property Query
*  I_STRICT = RS_C_TRUE "='X' exec. exactly the query (IPRO = ' ', QUERY = ' ' will not be added)

 IMPORTING
   E_TH_IO =  "Found LOIOs with relative URL (i.e. /FLDMETA/...)
   E_TS_IO_PROP =  "Properties of found LOIOs (only LOIO properties)
   E_REDUCED_BY_AUTHORITY =  "= 'X': Did not return all childs (to weak authorization)
   ERROR_TEXT =  "Error Text
   E_INFOPROVIDER_TYPE =  "Contains Infoprovider type

.

IMPORTING Parameters details for RSOD_BIRM_QUERY

I_DOC_CLASS - Document Class

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

I_T_QUPROP - Property Query

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

I_STRICT - ='X' exec. exactly the query (IPRO = SPACE, QUERY = SPACE will not be added)

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

EXPORTING Parameters details for RSOD_BIRM_QUERY

E_TH_IO - Found LOIOs with relative URL (i.e. /FLDMETA/...)

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

E_TS_IO_PROP - Properties of found LOIOs (only LOIO properties)

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

E_REDUCED_BY_AUTHORITY - = 'X': Did not return all childs (to weak authorization)

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

ERROR_TEXT - Error Text

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

E_INFOPROVIDER_TYPE - Contains Infoprovider type

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

Copy and paste ABAP code example for RSOD_BIRM_QUERY 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 RSOD_BIRM_QUERY

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