Search Results get_warnings

Overview

The APPS.HR_PAYROLLS package is a payroll period management utility within the Oracle E-Business Suite HRMS schema. Its primary business function is to generate and maintain the time periods associated with a payroll definition — the dated processing cycles against which payroll runs, costing, and reporting are driven. The package exposes a public record type, payroll_rec_type, which encapsulates the defining attributes of a payroll for downstream processing: the payroll identifier, legislation code, number of years, period type, and a series of date offset attributes (pay date, cut-off date, pay advice date, direct deposit date, and payslip view date). The record also carries the derived base period type (weekly, semi-monthly, or monthly), a multiple factor describing how many base periods constitute a period type, and fields tracking the first start/end dates and the first-to-be-generated start/end dates for the current invocation. This structure allows callers to request period creation and to interrogate the resulting sequence of periods within a single, consistent interface. The package header dates to the 12.1.1 code line (pypyroll.pkh 120.0.12010000.1) and remains documented under 12.2.2 with an API classification of OTHER.

Key Procedures and Functions

ETRM documents twelve callable objects. CREATE_PAYROLL_PROC_PERIODS is the principal entry point, used both for the initial creation of periods for a payroll and for the generation of further periods on subsequent invocations. GET_PERIOD_DETAILS retrieves period attributes for a given payroll. DISPLAY_PERIOD_NAME and DISPLAY_PERIOD_NAME_FORCED return a formatted period name, with the forced variant overriding standard derivation. ENABLE_DISPLAY_FETCH participates in the display-name retrieval mechanism, permitting period display values to be fetched reliably for user-facing presentation. DERIVE_PAYROLL_DATES calculates the payroll date set from the configured offsets. GET_WARNINGS and CLEAR_WARNINGS provide a lightweight warning stack so that callers can surface non-fatal conditions and then reset state. SET_GLOBALS initialises package-level global variables required by the other routines. Finally, PREV_SEMI_MONTH and NEXT_SEMI_MONTH implement the specialised semi-monthly boundary arithmetic, where the multiple value advances or retards the period. Parameter lists are not published in the ETRM extract and should be verified against the package specification in the target instance.

Tables Accessed

The package operates against the payroll and period base tables. PAY_ALL_PAYROLLS_F supplies payroll definitions and date-offset columns and receives updates to period tracking fields. PER_TIME_PERIODS and its PER_TIME_PERIODS_S synonym counterpart hold the generated period rows and are the primary target of period creation. PER_TIME_PERIOD_TYPES and PAY_LEGISLATION_RULES supply the period-type and legislative rules that govern valid period sequences per territory. PAY_PAYROLL_ACTIONS links payroll runs to the periods they consume. DBMS_SQL and DUAL are used for dynamic statement execution and scalar evaluation within the package body.

Usage Notes

The package is typically invoked from the Payroll Periods window and related payroll definition forms, from concurrent programs that pre-generate future periods, and from custom PL/SQL that needs to derive or extend a payroll calendar. Because it is referenced by seventeen other packages, modifications carry broad impact. Callers should invoke SET_GLOBALS before dependent routines, inspect GET_WARNINGS after creation calls, and treat ENABLE_DISPLAY_FETCH as the supported route for obtaining period display names in custom user interfaces.