SAP ABAP Class CL_HRPAYMX_PAYROLL (Class for payroll execution)

Hierarchy

☛ SAP_HRRXX (Software Component) Sub component SAP_HRRXX of SAP_HR
   ⤷ PY-XX-RS (Application Component) Reuse Services for Country Development
     ⤷ P99L (Package) Payroll Latin America

Properties

Class	CL_HRPAYMX_PAYROLL
Short Description	Class for payroll execution
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	P99L	Payroll Latin America
Created	20001215	SAP
Last change	20040819	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_HRPAYMX_PAYROLL has no forward declaration.

Interfaces

Class CL_HRPAYMX_PAYROLL has no interface implemented.

Friends

Class CL_HRPAYMX_PAYROLL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	EMPLOYEE_LIST	Instance attribute	Private	☐	Type reference (TYPE)	PMXGEN_T_PERNR		Table with pernr and error code from payroll run	20001215
2	FORM	Instance attribute	Private	☐	Type reference (TYPE)	HRCEDTVA		Display variant remuneration statement	20010405
3	GLOBAL_MOLGA	Instance attribute	Private	☐	Type reference (TYPE)	MOLGA		Country Grouping	20010608
4	OCR_ADJUST	Instance attribute	Private	☐	Type reference (TYPE)	PAY_OCRSN		Reason for Off-Cycle Payroll	20010316
5	OCR_FUTPER	Instance attribute	Private	☐	Type reference (TYPE)	PAY_OCRSN		Reason for Off-Cycle Payroll	20051103
6	OCR_ONDEMAND	Instance attribute	Private	☐	Type reference (TYPE)	PAY_OCRSN		Reason for Off-Cycle Payroll	20010316
7	PAYROLL_DATA	Instance attribute	Private	☐	Type reference (TYPE)	PMXGEN_T_PAYDATA		Table with useful information to run payroll	20001215
8	PAYR_LOG	Instance attribute	Private	☐	Type reference (TYPE)	PRT_PROT		Activate log	20010117
9	PROGRAM	Instance attribute	Private	☐	Type reference (TYPE)	SY-REPID		Payroll program	20010405
10	RT_TAB	Instance attribute	Private	☐	Type reference (TYPE)	PMXPAY_T_RT_TAB		Table with pernr and its RT table from payroll run	20010209
11	TEST	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Simulation flag	20020415
12	TIME_LOG	Instance attribute	Private	☐	Type reference (TYPE)	SW_INTIM		Integration with Time Management	20010117
13	VARIANT	Instance attribute	Private	☐	Type reference (TYPE)	VARIANT		Payroll variant	20010405

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_EE	Instance method	Public	Method	Add employee to be procesed by payroll	20001215
2	CLEAR_BUFFERS	Instance method	Public	Method	Free payroll buffers from memory	20010122
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20001215
4	FILL_FORM	Instance method	Public	Method	Fill payslip	20010612
5	FILL_REGULAR_RUN	Instance method	Private	Method	Insert entry into internal table with payroll parameters	20010316
6	FORCE_IT3_DATE	Instance method	Private	Method	Fix RRDAT field of IT 0003 when neeed for simulation	20010322
7	GET_EDT_FORM	Instance method	Public	Method	Get payslip	20010215
8	GET_PAYROLL_PERIOD	Instance method	Private	Method	Get payroll period and area for a given date	20010321
9	GET_RESULTS	Instance method	Public	Method	Return table with pernr and its RT tables	20010209
10	IMPORT_RESULTS	Instance method	Private	Method	Import RT from memory	20010321
11	IMPORT_RT	Instance method	Private	Method	Import RT from memory	20010626
12	REJECT_EE	Instance method	Public	Method	Discard employee from further processing	20010124
13	SHOW_LOG	Instance method	Public	Method	Show payroll log	20001215
14	SUBMIT	Instance method	Public	Method	Submit payroll	20001215

Events

Class CL_HRPAYMX_PAYROLL has no event.

Types

Class CL_HRPAYMX_PAYROLL has no local type.

Method Signatures

Method ADD_EE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PAYDT	Value transfer	☐	Type reference (TYPE)	BONDT		Relevant payroll date	20010321
2	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010316
3	Importing	REQ_BONDT	Value transfer	☑	Type reference (TYPE)	BONDT		Requested payment date	20010612
4	Importing	RUNTY	Value transfer	☐	Type reference (TYPE)	CHAR1	SPACE	Payroll run type	20010316

#	Exception	Resumable	Description	Created on
1	INVALID_RUNTY	☐	Invalid runty parameter	20010316
2	NO_CLUSTER_RESULTS	☐	No valid results in cluster (rgdir)	20010503
3	PERIOD_ERROR	☐	Error determining payroll period	20010503
4	PRESENT	☐	Employee already present in list	20010316

Method CLEAR_BUFFERS Signature

Method CLEAR_BUFFERS on class CL_HRPAYMX_PAYROLL has no parameter.
Method CLEAR_BUFFERS on class CL_HRPAYMX_PAYROLL has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MOLGA	Value transfer	☐	Type reference (TYPE)	MOLGA		Country Grouping	20010608
2	Importing	OPTIONS	Value transfer	☐	Type reference (TYPE)	PLATRM_S_OPTIONS		Options for termination program HLACTRM0	20051103
3	Importing	PY_REPID	Value transfer	☑	Type reference (TYPE)	SY-REPID		Payroll program	20010405
4	Importing	PY_VARIANT	Value transfer	☑	Type reference (TYPE)	VARIANT		Payroll variant	20010405

#	Exception	Resumable	Description	Created on
1	INVALID_PAYROLL_PROGRAM	☐	Invalid/not existing payroll (CALC) program in table T52OCV	20020730
2	INVALID_PAYROLL_VARIANT	☐	Invalid/not existing payroll (CALC) variant in table T52OCV	20020730
3	NO_PAYROLL_VARIANT	☐	No variant for 'CALC' spcified in table T52OCV	20020730

Method FILL_FORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATE	Value transfer	☑	Type reference (TYPE)	DATUM		Date	20010612
2	Importing	EDT_VAR	Value transfer	☑	Type reference (TYPE)	HRCEDTVA		Display variant remuneration statement	20010612
3	Importing	INFTYP_REC	Value transfer	☑	Type reference (TYPE)	PRELP		HR Master Data Buffer	20040401
4	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	P_PERNR		Personnel number	20010612

Method FILL_FORM on class CL_HRPAYMX_PAYROLL has no exception.

Method FILL_REGULAR_RUN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATE	Value transfer	☐	Type reference (TYPE)	BONDT		Payroll relevant date	20010316
2	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	P_PERNR		Personnel number	20010316
3	Importing	REQ_BONDT	Value transfer	☑	Type reference (TYPE)	BONDT		Requested payroll payment date	20010612

#	Exception	Resumable	Description	Created on
1	NO_CLUSTER_RESULTS	☐	No record found in cluster	20010503
2	PERIOD_ERROR	☐	Error determining payroll period	20010503

Method FORCE_IT3_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	LOG_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_HRPAYMX_APPLOG		Class for Application log	20050815
2	Changing	OBJ_IPREL	Call by reference	☐	Object reference (TYPE REF TO)	CL_HRPAY99_FILL_INFOTYPES		Iprel object	20010322
3	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010322
4	Importing	RRDAT	Value transfer	☐	Type reference (TYPE)	P0003-RRDAT		HR Master Record: Infotype 0003 (Payroll Status)	20010322

Method FORCE_IT3_DATE on class CL_HRPAYMX_PAYROLL has no exception.

Method GET_EDT_FORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FORM	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Table of type PC408	20010417
2	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010215

Method GET_EDT_FORM on class CL_HRPAYMX_PAYROLL has no exception.

Method GET_PAYROLL_PERIOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ABKRS	Call by reference	☐	Type reference (TYPE)	ABKRS		Payroll Area	20010321
2	Importing	DATE	Value transfer	☐	Type reference (TYPE)	SYDATE		Date data element for SYST	20010321
3	Exporting	PABRJ	Call by reference	☐	Type reference (TYPE)	PABRJ		Accounting year	20010321
4	Exporting	PABRP	Call by reference	☐	Type reference (TYPE)	PABRP		Accounting period	20010321
5	Exporting	PERIOD	Call by reference	☐	Type reference (TYPE)	PC261-INPER		In-period for payroll	20010321
6	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010321

#	Exception	Resumable	Description	Created on
1	IT1_ERROR	☐	Error readind IT 0001	20010322
2	T549A_ERROR	☐	Error reading table T549A	20010322
3	T549Q_ERROR	☐	Error reading table T549Q	20010322

Method GET_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PAYDATA	Call by reference	☐	Type reference (TYPE)	PMXGEN_T_PAYDATA		Table with useful information to run payroll	20010212
2	Exporting	RT_TABLE	Call by reference	☐	Type reference (TYPE)	PMXPAY_T_RT_TAB		Table with pernr and its RT table from payroll run	20010209

Method GET_RESULTS on class CL_HRPAYMX_PAYROLL has no exception.

Method IMPORT_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010321

#	Exception	Resumable	Description	Created on
1	NO_RESULTS_FOUND	☐	Error getting results from memory	20010322

Method IMPORT_RT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BONDT	Value transfer	☑	Type reference (TYPE)	BONDT		Off-cycle payroll payment date	20010626
2	Importing	DATE	Value transfer	☐	Type reference (TYPE)	DATUM		Date	20010626
3	Importing	FPPER_DATE	Call by reference	☑	Type reference (TYPE)	PC261-FPBEG		Start date of payroll period (FOR period)	20010628
4	Exporting	NETO	Call by reference	☐	Type reference (TYPE)	PRBETRG		Net payment	20010628
5	Importing	PAYID	Value transfer	☑	Type reference (TYPE)	PAYID		Payroll identifier	20010626
6	Importing	PAYTY	Value transfer	☑	Type reference (TYPE)	PAYTY		Payroll type	20010626
7	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010626
8	Exporting	RT	Call by reference	☐	Type reference (TYPE)	HRPAY99_RT		Results Table	20010626

#	Exception	Resumable	Description	Created on
1	NO_RESULTS_FOUND	☐	NO RESULTS FOUND	20010626

Method REJECT_EE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERNR	Value transfer	☐	Type reference (TYPE)	PERNR_D		Personnel Number	20010124

Method REJECT_EE on class CL_HRPAYMX_PAYROLL has no exception.

Method SHOW_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERNR	Call by reference	☑	Type reference (TYPE)	PERNR_D		Personnel Number	20010207
2	Exporting	SPOOL_NR_TAB	Call by reference	☐	Type reference (TYPE)	PLAGEN_T_SPOOL		Table of spool number s and ID	20011031

Method SHOW_LOG on class CL_HRPAYMX_PAYROLL has no exception.

Method SUBMIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EMPLOYEE_TAB	Call by reference	☐	Type reference (TYPE)	PMXGEN_T_PERNR		Table with pernr and error code from payroll run	20010129
2	Changing	LOG_OBJ	Call by reference	☑	Object reference (TYPE REF TO)	CL_HRPAYMX_APPLOG		Class for Application log	20050815
3	Importing	MODE	Value transfer	☐	Type reference (TYPE)	CHAR10	'SIMULATION'	Flag for simualtion	20001215
4	Importing	OFF_CYCLE	Value transfer	☐	Type reference (TYPE)	CHAR1	SPACE	Off-cycle payroll indicator	20010111
5	Exporting	PAYROLL_INFO	Call by reference	☐	Type reference (TYPE)	PMXGEN_T_PAYDATA		Table with useful information to run payroll	20010808
6	Importing	RETRO	Value transfer	☑	Type reference (TYPE)	DATUM		Specify key date	20010109
7	Changing	SIM_OBJ	Call by reference	☑	Object reference (TYPE REF TO)	CL_HRPAY99_FILL_INFOTYPES		IPREL object with infotypes to simulate	20001215

#	Exception	Resumable	Description	Created on
1	NO_RESULTS_FOUND	☐	Error importing RT table from memory	20010322
2	PERIOD_ERROR	☐	Error determining payroll period	20010322

History

Last changed by/on	SAP	20040819
SAP Release Created in	46C