SAP UJF_API_GET_DOCU_WITH_FILTER Function Module for File Services - Get Documents With Filter

Search SAP Function Modules

UJF_API_GET_DOCU_WITH_FILTER is a standard ujf api get docu with filter SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for File Services - Get Documents With Filter 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 ujf api get docu with filter FM, simply by entering the name UJF_API_GET_DOCU_WITH_FILTER into the relevant SAP transaction such as SE37 or SE38.

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

Function UJF_API_GET_DOCU_WITH_FILTER 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 'UJF_API_GET_DOCU_WITH_FILTER'"File Services - Get Documents With Filter
  EXPORTING
   I_USER =  "BPC User Information
   I_APPSET =  "AppSet Name
   IT_PATTERN_TAB =  "Table of Pattern Strings

 IMPORTING
   ET_DOC_ATTRIBUTES =  "BPC: Document Table Type
   ET_DOC_TREE =  "BPC: Document Tree Table Type
   E_MESSAGE_LINES =  "Messages

EXCEPTIONS
   SYSTEM_FAILURE = 1    COMMUNICATION_FAILURE = 2 

.

IMPORTING Parameters details for UJF_API_GET_DOCU_WITH_FILTER

I_USER - BPC User Information

Data type: UJ0_S_USER
Optional: No
Call by Reference: Yes

I_APPSET - AppSet Name

Data type: UJF_DOC-APPSET
Optional: No
Call by Reference: Yes

IT_PATTERN_TAB - Table of Pattern Strings

Data type: UJF_T_CHAR255
Optional: No
Call by Reference: Yes

EXPORTING Parameters details for UJF_API_GET_DOCU_WITH_FILTER

ET_DOC_ATTRIBUTES - BPC: Document Table Type

Data type: UJF_T_DOC
Optional: No
Call by Reference: Yes

ET_DOC_TREE - BPC: Document Tree Table Type

Data type: UJF_T_DOCTREE
Optional: No
Call by Reference: Yes

E_MESSAGE_LINES - Messages

Data type: UJ0_T_MESSAGE
Optional: No
Call by Reference: Yes

EXCEPTIONS details

SYSTEM_FAILURE - System Failure Exception

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

COMMUNICATION_FAILURE - Communication Failure Exception

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

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

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