SAP UI_DOC_GET Function Module for

Search SAP Function Modules

UI_DOC_GET is a standard ui doc get 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 ui doc get FM, simply by entering the name UI_DOC_GET into the relevant SAP transaction such as SE37 or SE38.

Function Group: UI_SERVICES
Program Name: SAPLUI_SERVICES
Main Program: SAPLUI_SERVICES
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:

Function UI_DOC_GET 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 'UI_DOC_GET'"
  EXPORTING
   I_DOC_ID =  "
*  I_BDS_DOC_ID = ' ' "Business Document Service: Document ID
*  I_RFCDEST =  "Logical Destination (Specified when Calling Function)

 IMPORTING
   ET_DOC_CONTENT =  "Document Content (SEM-BIC Data Basis)
   E_DOC_SIZE =  "Document Size (Documents in the SEM-BIC Data Basis)
   E_DOC_TYPE =  "Document Type (MS Word, Excel, Powerpoint...)
   ET_DOC_AS_CONTENT =  "ASCII Table

TABLES
*  ET_ASSIGNED_CHAS =  "Assigned Chars/Char. Values (Documents SEM-BIC Data Basis)
*  ET_ASSIGNED_KYFS =  "Assigned Key Figures (Documents of SEM-BIC Data Basis)
*  ET_FIX_PROP =  "Other Fixed Attributes (Documents of SEM-BIC Data Basis)

EXCEPTIONS
   LOAD_ERROR = 1    NO_DOC_ID = 2    INVALID_DOC_ID = 3    NO_BDS_DOC_ID = 4    EMPTY_BUFFER = 5    RFC_ERROR = 6 

.

IMPORTING Parameters details for UI_DOC_GET

I_DOC_ID -

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

I_BDS_DOC_ID - Business Document Service: Document ID

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

I_RFCDEST - Logical Destination (Specified when Calling Function)

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

EXPORTING Parameters details for UI_DOC_GET

ET_DOC_CONTENT - Document Content (SEM-BIC Data Basis)

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

E_DOC_SIZE - Document Size (Documents in the SEM-BIC Data Basis)

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

E_DOC_TYPE - Document Type (MS Word, Excel, Powerpoint...)

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

ET_DOC_AS_CONTENT - ASCII Table

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

TABLES Parameters details for UI_DOC_GET

ET_ASSIGNED_CHAS - Assigned Chars/Char. Values (Documents SEM-BIC Data Basis)

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

ET_ASSIGNED_KYFS - Assigned Key Figures (Documents of SEM-BIC Data Basis)

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

ET_FIX_PROP - Other Fixed Attributes (Documents of SEM-BIC Data Basis)

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

EXCEPTIONS details

LOAD_ERROR - Error while loading document

Data type:
Optional: No
Call by Reference: Yes

NO_DOC_ID -

Data type:
Optional: No
Call by Reference: Yes

INVALID_DOC_ID -

Data type:
Optional: No
Call by Reference: Yes

NO_BDS_DOC_ID -

Data type:
Optional: No
Call by Reference: Yes

EMPTY_BUFFER -

Data type:
Optional: No
Call by Reference: Yes

RFC_ERROR - Error During RFC Call

Data type:
Optional: No
Call by Reference: Yes

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

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