SAP CACS_PROGINDICATOR_SHOW Function Module for Generalized SAPGUI_PROGRESS_INDICATOR









CACS_PROGINDICATOR_SHOW is a standard cacs progindicator show SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Generalized SAPGUI_PROGRESS_INDICATOR 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 cacs progindicator show FM, simply by entering the name CACS_PROGINDICATOR_SHOW into the relevant SAP transaction such as SE37 or SE38.

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



Function CACS_PROGINDICATOR_SHOW 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 'CACS_PROGINDICATOR_SHOW'"Generalized SAPGUI_PROGRESS_INDICATOR
EXPORTING
* PERCENTAGE = 0 "Size of Bar ( 0 <= PERCENTAGE <= 100 )
* XDIALOG = 'X' "Display in Dialog? (=> PROGRES_INDICATOR)
* XBATCH = 'X' "Display in Batch (=> Job Log)
* XNEWMESSAGE = ' ' "Display Only New Messages?
* TEXT = ' ' "Text to be Displayed
* MESSAGECLASS = ' ' "Message Class (in case TEXT initial)
* MESSAGENUMBER = 000 "Message (in case TEXT initial)
* MESSAGEPAR1 = ' ' "Parameter 1 for Message (In case TEXT initial)
* MESSAGEPAR2 = ' ' "Parameter 2 for Message (In case TEXT initial)
* MESSAGEPAR3 = ' ' "Parameter 3 for Message (In case TEXT initial)
* MESSAGEPAR4 = ' ' "Parameter 4 for Message (In case TEXT initial)
* TIMECONDITION = 0 "Minimum Number of Seconds Between Two Calls
.



IMPORTING Parameters details for CACS_PROGINDICATOR_SHOW

PERCENTAGE - Size of Bar ( 0 <= PERCENTAGE <= 100 )

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

XDIALOG - Display in Dialog? (=> PROGRES_INDICATOR)

Data type: BOOLEAN_FLG
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

XBATCH - Display in Batch (=> Job Log)

Data type: BOOLEAN_FLG
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

XNEWMESSAGE - Display Only New Messages?

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

TEXT - Text to be Displayed

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

MESSAGECLASS - Message Class (in case TEXT initial)

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

MESSAGENUMBER - Message (in case TEXT initial)

Data type: SY-MSGNO
Default: 000
Optional: Yes
Call by Reference: No ( called with pass by value option)

MESSAGEPAR1 - Parameter 1 for Message (In case TEXT initial)

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

MESSAGEPAR2 - Parameter 2 for Message (In case TEXT initial)

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

MESSAGEPAR3 - Parameter 3 for Message (In case TEXT initial)

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

MESSAGEPAR4 - Parameter 4 for Message (In case TEXT initial)

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

TIMECONDITION - Minimum Number of Seconds Between Two Calls

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

Copy and paste ABAP code example for CACS_PROGINDICATOR_SHOW 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_percentage  TYPE STRING, "   0
lv_xdialog  TYPE BOOLEAN_FLG, "   'X'
lv_xbatch  TYPE BOOLEAN_FLG, "   'X'
lv_xnewmessage  TYPE BOOLEAN_FLG, "   SPACE
lv_text  TYPE BOOLEAN_FLG, "   SPACE
lv_messageclass  TYPE SY-MSGID, "   SPACE
lv_messagenumber  TYPE SY-MSGNO, "   000
lv_messagepar1  TYPE SY-MSGV1, "   SPACE
lv_messagepar2  TYPE SY-MSGV2, "   SPACE
lv_messagepar3  TYPE SY-MSGV3, "   SPACE
lv_messagepar4  TYPE SY-MSGV4, "   SPACE
lv_timecondition  TYPE SY. "   0

  CALL FUNCTION 'CACS_PROGINDICATOR_SHOW'  "Generalized SAPGUI_PROGRESS_INDICATOR
    EXPORTING
         PERCENTAGE = lv_percentage
         XDIALOG = lv_xdialog
         XBATCH = lv_xbatch
         XNEWMESSAGE = lv_xnewmessage
         TEXT = lv_text
         MESSAGECLASS = lv_messageclass
         MESSAGENUMBER = lv_messagenumber
         MESSAGEPAR1 = lv_messagepar1
         MESSAGEPAR2 = lv_messagepar2
         MESSAGEPAR3 = lv_messagepar3
         MESSAGEPAR4 = lv_messagepar4
         TIMECONDITION = lv_timecondition
. " CACS_PROGINDICATOR_SHOW




ABAP code using 7.40 inline data declarations to call FM CACS_PROGINDICATOR_SHOW

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.

 
DATA(ld_xdialog) = 'X'.
 
DATA(ld_xbatch) = 'X'.
 
DATA(ld_xnewmessage) = ' '.
 
DATA(ld_text) = ' '.
 
"SELECT single MSGID FROM SY INTO @DATA(ld_messageclass).
DATA(ld_messageclass) = ' '.
 
"SELECT single MSGNO FROM SY INTO @DATA(ld_messagenumber).
DATA(ld_messagenumber) = 000.
 
"SELECT single MSGV1 FROM SY INTO @DATA(ld_messagepar1).
DATA(ld_messagepar1) = ' '.
 
"SELECT single MSGV2 FROM SY INTO @DATA(ld_messagepar2).
DATA(ld_messagepar2) = ' '.
 
"SELECT single MSGV3 FROM SY INTO @DATA(ld_messagepar3).
DATA(ld_messagepar3) = ' '.
 
"SELECT single MSGV4 FROM SY INTO @DATA(ld_messagepar4).
DATA(ld_messagepar4) = ' '.
 
 


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!