SAP HRHAP_DOCUMENT_PREPARE Function Module for









HRHAP_DOCUMENT_PREPARE is a standard hrhap document prepare SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 hrhap document prepare FM, simply by entering the name HRHAP_DOCUMENT_PREPARE into the relevant SAP transaction such as SE37 or SE38.

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



Function HRHAP_DOCUMENT_PREPARE 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 'HRHAP_DOCUMENT_PREPARE'"
EXPORTING
* ADD_ON_APPL = "
* ADMINISTRATOR = "
* TEST = "
* SKIP_IN_PREP = "
PLAN_VERSION = "
TEMPLATE_ID = "
* DOCUMENT_NAME = "
AP_START_DATE = "
AP_END_DATE = "
T_APPRAISER = "
T_APPRAISEE = "
* T_PART_APPRAISERS = "

IMPORTING
T_RETURN = "
.



IMPORTING Parameters details for HRHAP_DOCUMENT_PREPARE

ADD_ON_APPL -

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

ADMINISTRATOR -

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

TEST -

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

SKIP_IN_PREP -

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

PLAN_VERSION -

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

TEMPLATE_ID -

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

DOCUMENT_NAME -

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

AP_START_DATE -

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

AP_END_DATE -

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

T_APPRAISER -

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

T_APPRAISEE -

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

T_PART_APPRAISERS -

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

EXPORTING Parameters details for HRHAP_DOCUMENT_PREPARE

T_RETURN -

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

Copy and paste ABAP code example for HRHAP_DOCUMENT_PREPARE 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_t_return  TYPE HAP_T_MSG, "   
lv_add_on_appl  TYPE HAP_ADD_ON_APPLICATION, "   
lv_administrator  TYPE HAP_ADMINISTRATOR, "   
lv_test  TYPE BOOLE_D, "   
lv_skip_in_prep  TYPE BOOLE_D, "   
lv_plan_version  TYPE HAP_PLAN_VERSION, "   
lv_template_id  TYPE HAP_TEMPLATE_ID, "   
lv_document_name  TYPE HAP_APPRAISAL_NAME, "   
lv_ap_start_date  TYPE HAP_AP_START_DATE, "   
lv_ap_end_date  TYPE HAP_AP_END_DATE, "   
lv_t_appraiser  TYPE HAP_T_HEADER_APPRAISER, "   
lv_t_appraisee  TYPE HAP_T_HEADER_APPRAISEE, "   
lv_t_part_appraisers  TYPE HAP_T_HEADER_PART_APPRAISERS. "   

  CALL FUNCTION 'HRHAP_DOCUMENT_PREPARE'  "
    EXPORTING
         ADD_ON_APPL = lv_add_on_appl
         ADMINISTRATOR = lv_administrator
         TEST = lv_test
         SKIP_IN_PREP = lv_skip_in_prep
         PLAN_VERSION = lv_plan_version
         TEMPLATE_ID = lv_template_id
         DOCUMENT_NAME = lv_document_name
         AP_START_DATE = lv_ap_start_date
         AP_END_DATE = lv_ap_end_date
         T_APPRAISER = lv_t_appraiser
         T_APPRAISEE = lv_t_appraisee
         T_PART_APPRAISERS = lv_t_part_appraisers
    IMPORTING
         T_RETURN = lv_t_return
. " HRHAP_DOCUMENT_PREPARE




ABAP code using 7.40 inline data declarations to call FM HRHAP_DOCUMENT_PREPARE

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!