SAP UJF_API_GET_ZIPPED_DOCUMENT Function Module for File Services - Get Zipped Document

Search SAP Function Modules

UJF_API_GET_ZIPPED_DOCUMENT is a standard ujf api get zipped document 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 Zipped Document 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 zipped document FM, simply by entering the name UJF_API_GET_ZIPPED_DOCUMENT 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): Remote-Enabled
Update:

Function UJF_API_GET_ZIPPED_DOCUMENT 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_ZIPPED_DOCUMENT'"File Services - Get Zipped Document
  EXPORTING
   I_USER =  "BPC User Information
   I_APPSET =  "AppSet Name
*  I_INCL_SUBDIR_STRUCT = 'N' "Include Sub-Directory Structures
   I_DOC_DIR_TABLE =  "Document /Directory List

 IMPORTING
   E_DOC_CONTENT =  "Document Content
   E_MESSAGE_LINES =  "Messages

EXCEPTIONS
   SYSTEM_FAILURE = 1    COMMUNICATION_FAILURE = 2 

.

IMPORTING Parameters details for UJF_API_GET_ZIPPED_DOCUMENT

I_USER - BPC User Information

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

I_APPSET - AppSet Name

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

I_INCL_SUBDIR_STRUCT - Include Sub-Directory Structures

Data type: UJ_BOOL
Default: 'N'
Optional: No
Call by Reference: No ( called with pass by value option)

I_DOC_DIR_TABLE - Document /Directory List

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

EXPORTING Parameters details for UJF_API_GET_ZIPPED_DOCUMENT

E_DOC_CONTENT - Document Content

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

E_MESSAGE_LINES - Messages

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

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_ZIPPED_DOCUMENT 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_ZIPPED_DOCUMENT

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