SAP UPX_PAGINATION_API Function Module for UPX Pagination API









UPX_PAGINATION_API is a standard upx pagination api SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for UPX Pagination API 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 upx pagination api FM, simply by entering the name UPX_PAGINATION_API into the relevant SAP transaction such as SE37 or SE38.

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



Function UPX_PAGINATION_API 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 'UPX_PAGINATION_API'"UPX Pagination API
EXPORTING
IV_AREA = "Planning Area
IV_LEVEL = "Planning level
IV_LAYOUT = "Parameter Group

IMPORTING
EV_CHANM = "Characteristic
EV_VAR = "Variable
EV_PAGE_SIZE = "UPX Pagination Size

EXCEPTIONS
INVALID_UPX = 1 LAYOUT_NOT_PAGINATED = 2 BPS_ERROR = 3
.



IMPORTING Parameters details for UPX_PAGINATION_API

IV_AREA - Planning Area

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

IV_LEVEL - Planning level

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

IV_LAYOUT - Parameter Group

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

EXPORTING Parameters details for UPX_PAGINATION_API

EV_CHANM - Characteristic

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

EV_VAR - Variable

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

EV_PAGE_SIZE - UPX Pagination Size

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

EXCEPTIONS details

INVALID_UPX - No information found for area, level and layer

Data type:
Optional: No
Call by Reference: Yes

LAYOUT_NOT_PAGINATED - No pagination information found for layout

Data type:
Optional: No
Call by Reference: Yes

BPS_ERROR - UPX does not reflect BPS

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for UPX_PAGINATION_API 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:
lv_iv_area  TYPE UPC_Y_AREA, "   
lv_ev_chanm  TYPE UPC_Y_CHANM, "   
lv_invalid_upx  TYPE UPC_Y_CHANM, "   
lv_ev_var  TYPE UPC_Y_VARIABLE, "   
lv_iv_level  TYPE UPC_Y_PLEVEL, "   
lv_layout_not_paginated  TYPE UPC_Y_PLEVEL, "   
lv_bps_error  TYPE UPC_Y_PLEVEL, "   
lv_iv_layout  TYPE UPC_Y_PARAM, "   
lv_ev_page_size  TYPE UPX_PAGE_SIZE. "   

  CALL FUNCTION 'UPX_PAGINATION_API'  "UPX Pagination API
    EXPORTING
         IV_AREA = lv_iv_area
         IV_LEVEL = lv_iv_level
         IV_LAYOUT = lv_iv_layout
    IMPORTING
         EV_CHANM = lv_ev_chanm
         EV_VAR = lv_ev_var
         EV_PAGE_SIZE = lv_ev_page_size
    EXCEPTIONS
        INVALID_UPX = 1
        LAYOUT_NOT_PAGINATED = 2
        BPS_ERROR = 3
. " UPX_PAGINATION_API




ABAP code using 7.40 inline data declarations to call FM UPX_PAGINATION_API

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



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!