SAP HR_PAYROLL_SIMULATION Function Module for Start Payroll in Simulation

Search SAP Function Modules

HR_PAYROLL_SIMULATION is a standard hr payroll simulation SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Start Payroll in Simulation 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 hr payroll simulation FM, simply by entering the name HR_PAYROLL_SIMULATION into the relevant SAP transaction such as SE37 or SE38.

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

Function HR_PAYROLL_SIMULATION 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 'HR_PAYROLL_SIMULATION'"Start Payroll in Simulation
  EXPORTING
*  PAYROLL_AREA =  "Payroll Area
   EMPLOYEE_NUMBER =  "Personnel Number
*  PAYROLL_PERIOD =  "Payroll period
*  PAYROLL_YEAR =  "Payroll year
*  PAYROLL_TYPE =  "Payroll type
*  PAYROLL_ID =  "Payroll ID
*  PAYROLL_DATE =  "Date of Payroll Run
   SELECTION_VARIANT =  "Report Variant for Payroll
   PROGRAM_NAME =  "Name of Payroll Program
*  OFF_CYCLE = ' ' "Flag: Off-Cycle Payroll yes/no ('X', ' ')

EXCEPTIONS
   PROGRAM_NOT_EXIST = 1    VARIANT_NOT_EXIST = 2    MISSING_PARAMETER = 3    WRONG_PARAMETER = 4    WRONG_COUNTRY_GROUP = 5    UNKNOWN_ERROR = 6 

.

IMPORTING Parameters details for HR_PAYROLL_SIMULATION

PAYROLL_AREA - Payroll Area

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

EMPLOYEE_NUMBER - Personnel Number

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

PAYROLL_PERIOD - Payroll period

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

PAYROLL_YEAR - Payroll year

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

PAYROLL_TYPE - Payroll type

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

PAYROLL_ID - Payroll ID

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

PAYROLL_DATE - Date of Payroll Run

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

SELECTION_VARIANT - Report Variant for Payroll

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

PROGRAM_NAME - Name of Payroll Program

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

OFF_CYCLE - Flag: Off-Cycle Payroll yes/no ('X', ' ')

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

EXCEPTIONS details

PROGRAM_NOT_EXIST - Payroll Program Does Not Exist

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

VARIANT_NOT_EXIST - Variant does not exist

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

MISSING_PARAMETER - An Input Parameter was not Specified

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

WRONG_PARAMETER - There is an Incorrect Parameter Combination

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

WRONG_COUNTRY_GROUP - The Payroll Country Grouping is Incorrect

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

UNKNOWN_ERROR - Unknown error

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

Copy and paste ABAP code example for HR_PAYROLL_SIMULATION 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.

ABAP code using 7.40 inline data declarations to call FM HR_PAYROLL_SIMULATION

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