SAP HCMFAB_CATS_GET_VALUEHELP Function Module for Get Data for ValueHelp Entity









HCMFAB_CATS_GET_VALUEHELP is a standard hcmfab cats get valuehelp SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Get Data for ValueHelp Entity 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 hcmfab cats get valuehelp FM, simply by entering the name HCMFAB_CATS_GET_VALUEHELP into the relevant SAP transaction such as SE37 or SE38.

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



Function HCMFAB_CATS_GET_VALUEHELP 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 'HCMFAB_CATS_GET_VALUEHELP'"Get Data for ValueHelp Entity
EXPORTING
* IV_PERNR = "Personnel number
* IT_SEARCH_SELECTION = "My Timesheet Key Value table
* IV_SKIP_SEARCH = "Flag for skipping the search for similar fields
* IV_DATAENTRYPROFILE = "Profile ID
* IV_FINAL = "Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')
* IV_FIELDNAME = "Field Name
* IV_BEGDA = "Start Date
* IV_ENDDA = "End Date
* IV_TABNAME = 'CATSDB' "Field Name
* IV_SEARCH_STRING = "
* IS_PAGING = "paging structure

IMPORTING
ET_VALUEHELP = "My Timesheet value help List
ES_LEADING_MESSAGE = "Return Parameter
ET_MESSAGES = "Table with BAPI Return Information
.



IMPORTING Parameters details for HCMFAB_CATS_GET_VALUEHELP

IV_PERNR - Personnel number

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

IT_SEARCH_SELECTION - My Timesheet Key Value table

Data type: HCMFAB_T_TIMESHEET_KEYVALUES
Optional: Yes
Call by Reference: Yes

IV_SKIP_SEARCH - Flag for skipping the search for similar fields

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

IV_DATAENTRYPROFILE - Profile ID

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

IV_FINAL - Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')

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

IV_FIELDNAME - Field Name

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

IV_BEGDA - Start Date

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

IV_ENDDA - End Date

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

IV_TABNAME - Field Name

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

IV_SEARCH_STRING -

Data type: STRING
Optional: Yes
Call by Reference: Yes

IS_PAGING - paging structure

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

EXPORTING Parameters details for HCMFAB_CATS_GET_VALUEHELP

ET_VALUEHELP - My Timesheet value help List

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

ES_LEADING_MESSAGE - Return Parameter

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

ET_MESSAGES - Table with BAPI Return Information

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

Copy and paste ABAP code example for HCMFAB_CATS_GET_VALUEHELP 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_pernr  TYPE PERNR_D, "   
lv_et_valuehelp  TYPE HCMFAB_T_TIMESHEET_VALUEHELP, "   
lv_it_search_selection  TYPE HCMFAB_T_TIMESHEET_KEYVALUES, "   
lv_iv_skip_search  TYPE BOOLE_D, "   
lv_es_leading_message  TYPE BAPIRET2, "   
lv_iv_dataentryprofile  TYPE CATSVARIAN, "   
lv_iv_final  TYPE BOOLE_D, "   
lv_et_messages  TYPE BAPIRETTAB, "   
lv_iv_fieldname  TYPE DDOBJNAME, "   
lv_iv_begda  TYPE DATUM, "   
lv_iv_endda  TYPE DATUM, "   
lv_iv_tabname  TYPE FIELDNAME, "   'CATSDB'
lv_iv_search_string  TYPE STRING, "   
lv_is_paging  TYPE /IWBEP/S_MGW_PAGING. "   

  CALL FUNCTION 'HCMFAB_CATS_GET_VALUEHELP'  "Get Data for ValueHelp Entity
    EXPORTING
         IV_PERNR = lv_iv_pernr
         IT_SEARCH_SELECTION = lv_it_search_selection
         IV_SKIP_SEARCH = lv_iv_skip_search
         IV_DATAENTRYPROFILE = lv_iv_dataentryprofile
         IV_FINAL = lv_iv_final
         IV_FIELDNAME = lv_iv_fieldname
         IV_BEGDA = lv_iv_begda
         IV_ENDDA = lv_iv_endda
         IV_TABNAME = lv_iv_tabname
         IV_SEARCH_STRING = lv_iv_search_string
         IS_PAGING = lv_is_paging
    IMPORTING
         ET_VALUEHELP = lv_et_valuehelp
         ES_LEADING_MESSAGE = lv_es_leading_message
         ET_MESSAGES = lv_et_messages
. " HCMFAB_CATS_GET_VALUEHELP




ABAP code using 7.40 inline data declarations to call FM HCMFAB_CATS_GET_VALUEHELP

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_iv_tabname) = 'CATSDB'.
 
 
 


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!