SAP HLP_ACTION_PERFORM Function Module for Online help: Callback to perform an action (transaction, link, ...)









HLP_ACTION_PERFORM is a standard hlp action perform SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Online help: Callback to perform an action (transaction, link, ...) 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 hlp action perform FM, simply by entering the name HLP_ACTION_PERFORM into the relevant SAP transaction such as SE37 or SE38.

Function Group: SH05
Program Name: SAPLSH05
Main Program: SAPLSH05
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function HLP_ACTION_PERFORM 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 'HLP_ACTION_PERFORM'"Online help: Callback to perform an action (transaction, link, ...)
EXPORTING
ACTION = "Action to perform
PARAMETERS = "

IMPORTING
HELP_TYPE_ON_RESTART = "
DISPLAY_MODE_ON_RESTART = "
WINDOW_TITLE_ON_RESTART = "

TABLES
RTF = "SAPscript: Text Lines
EXTENSION = "
ITF_ON_RESTART = "
RTF_ON_RESTART = "SAPscript: Text Lines
CAPTIONS_ON_RESTART = "
EXTENSION_ON_RESTART = "

EXCEPTIONS
PERFORM_ACTION_FAILED = 1
.



IMPORTING Parameters details for HLP_ACTION_PERFORM

ACTION - Action to perform

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

PARAMETERS -

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

EXPORTING Parameters details for HLP_ACTION_PERFORM

HELP_TYPE_ON_RESTART -

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

DISPLAY_MODE_ON_RESTART -

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

WINDOW_TITLE_ON_RESTART -

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

TABLES Parameters details for HLP_ACTION_PERFORM

RTF - SAPscript: Text Lines

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

EXTENSION -

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

ITF_ON_RESTART -

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

RTF_ON_RESTART - SAPscript: Text Lines

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

CAPTIONS_ON_RESTART -

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

EXTENSION_ON_RESTART -

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

EXCEPTIONS details

PERFORM_ACTION_FAILED - Action could not be performed

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

Copy and paste ABAP code example for HLP_ACTION_PERFORM 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:
lt_rtf  TYPE STANDARD TABLE OF TLINE, "   
lv_action  TYPE HLPFIELDS-ACTION, "   
lv_help_type_on_restart  TYPE HLPFIELDS-HELP_TYPE, "   
lv_perform_action_failed  TYPE HLPFIELDS, "   
lt_extension  TYPE STANDARD TABLE OF HLPEXT, "   
lv_parameters  TYPE HLPFIELDS-PARAMETERS, "   
lv_display_mode_on_restart  TYPE HLPFIELDS-DISP_MODE, "   
lt_itf_on_restart  TYPE STANDARD TABLE OF TLINE, "   
lv_window_title_on_restart  TYPE HLPFIELDS-TITLE, "   
lt_rtf_on_restart  TYPE STANDARD TABLE OF TLINE, "   
lt_captions_on_restart  TYPE STANDARD TABLE OF HLPCAPTION, "   
lt_extension_on_restart  TYPE STANDARD TABLE OF HLPEXT. "   

  CALL FUNCTION 'HLP_ACTION_PERFORM'  "Online help: Callback to perform an action (transaction, link, ...)
    EXPORTING
         ACTION = lv_action
         PARAMETERS = lv_parameters
    IMPORTING
         HELP_TYPE_ON_RESTART = lv_help_type_on_restart
         DISPLAY_MODE_ON_RESTART = lv_display_mode_on_restart
         WINDOW_TITLE_ON_RESTART = lv_window_title_on_restart
    TABLES
         RTF = lt_rtf
         EXTENSION = lt_extension
         ITF_ON_RESTART = lt_itf_on_restart
         RTF_ON_RESTART = lt_rtf_on_restart
         CAPTIONS_ON_RESTART = lt_captions_on_restart
         EXTENSION_ON_RESTART = lt_extension_on_restart
    EXCEPTIONS
        PERFORM_ACTION_FAILED = 1
. " HLP_ACTION_PERFORM




ABAP code using 7.40 inline data declarations to call FM HLP_ACTION_PERFORM

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.

 
"SELECT single ACTION FROM HLPFIELDS INTO @DATA(ld_action).
 
"SELECT single HELP_TYPE FROM HLPFIELDS INTO @DATA(ld_help_type_on_restart).
 
 
 
"SELECT single PARAMETERS FROM HLPFIELDS INTO @DATA(ld_parameters).
 
"SELECT single DISP_MODE FROM HLPFIELDS INTO @DATA(ld_display_mode_on_restart).
 
 
"SELECT single TITLE FROM HLPFIELDS INTO @DATA(ld_window_title_on_restart).
 
 
 
 


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!